/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/events/manage": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every event staff can see * @description Hidden ones too. Upcoming by default; `past`, `inactive` and `closed` (cashed-up) widen it. Campus-scoped staff see their campuses' events and church-wide ones. Not paged — it's what the event pickers search. * * **Who:** Staff, supervisors and admins. */ get: operations["getEventsManage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Upcoming public events * @description Events anyone can see (active, not hidden, live) that have not ended, soonest first. * * **Who:** Anyone. */ get: operations["getEvents"]; put?: never; /** * Create an event * @description Gets a "Main Ticket" at the event price (unless registration is off). A campus-scoped supervisor must choose one of their campuses. * * **Who:** Supervisors and admins. */ post: operations["postEvents"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One public event * @description With its ticket options (internal kids check-in and volunteer tickets left out) and sessions. Hidden events can be fetched by id (they are unlisted, not private). * * **Who:** Anyone. */ get: operations["getEventsId"]; put?: never; post?: never; /** * Deactivate an event * @description Admins only. The event is deactivated, not deleted: registrations, payments and tickets stay. * * **Who:** Admins only. */ delete: operations["deleteEventsId"]; options?: never; head?: never; /** * Change an event * @description Only the fields sent change. Sessions save with the event (a refused schedule change saves nothing). A cashed-up event can't change until an admin reopens it. The answer includes `sessionChanges` (added, moved, cancelled… counts) when sessions were sent. * * **Who:** Supervisors and admins. */ patch: operations["patchEventsId"]; trace?: never; }; "/events/{id}/copy-from": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Copy set-up from another event * @description Allocation groups, and planned costs for admins — used right after copying an event. * * **Who:** Supervisors and admins. */ post: operations["postEventsIdCopy-from"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/notify-recipients": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Who gets this event's emails * @description Registration, payment and daily-summary emails. * * **Who:** Supervisors and admins. */ get: operations["getEventsIdNotify-recipients"]; /** * Set who gets this event's emails * @description **Who:** Supervisors and admins. */ put: operations["putEventsIdNotify-recipients"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/full": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One event in full * @description What the registration page and the set-up screens need: ticket options with what's left (per variant, and per session for "pick sessions" tickets), early-bird tiers, sessions with bookings, the attendee form, attachments, bundle deals on sale and the next event in its series. * * Staff (of a campus they work with) also get inactive and not-yet-live events, who created it, who gets its emails, and the kids/volunteer tickets. Everyone else gets NOT_FOUND for events that aren't public. * * **Who:** Anyone; signed-in staff may see more. */ get: operations["getEventsIdFull"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/calendar.ics": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The event as a calendar file * @description An .ics file (each session for a multi-day event). Same visibility as the event. * * **Who:** Anyone; signed-in staff may see more. */ get: operations["getEventsIdCalendar.ics"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/by-alias/{alias}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event by its short link * @description The part after the site address (`/camp2026`), any letter case. Active events only. * * **Who:** Anyone. */ get: operations["getEventsBy-aliasAlias"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/ticket-options": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add a ticket option * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdTicket-options"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/ticket-options/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Remove a ticket option * @description Admins only. Not one anybody has bought, and never the event's only main ticket. * * **Who:** Admins only. */ delete: operations["deleteTicket-optionsId"]; options?: never; head?: never; /** * Change a ticket option * @description Only what's sent changes. `earlyBirdTiers` and `variants`, when sent, are the full lists: kept by id, added without one, and ones left out removed when nothing was bought under them. * * **Who:** Supervisors and admins. */ patch: operations["patchTicket-optionsId"]; trace?: never; }; "/ticket-options/{id}/variants": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add a variant (e.g. a T-shirt size) * @description **Who:** Supervisors and admins. */ post: operations["postTicket-optionsIdVariants"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/variants/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Remove a variant * @description Admins only, and not one anybody has bought. * * **Who:** Admins only. */ delete: operations["deleteVariantsId"]; options?: never; head?: never; /** * Change a variant * @description **Who:** Supervisors and admins. */ patch: operations["patchVariantsId"]; trace?: never; }; "/events/{id}/attachments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's attachments * @description Files for attendees (programmes, packing lists…), newest first. * * **Who:** Anyone. */ get: operations["getEventsIdAttachments"]; put?: never; /** * Attach a file to an event * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdAttachments"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/attachments/{attachmentId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Remove an attachment * @description **Who:** Supervisors and admins. */ delete: operations["deleteEventsIdAttachmentsAttachmentId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/attachments/status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Attachments diagnostics * @description **Who:** Admins only. */ get: operations["getAttachmentsStatus"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/attachments/sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Import attachments from old manifests * @description Attachments recorded in JSON files on disk by very old versions go into the database. `dryRun` only reports; `remove` deletes each manifest once imported. * * **Who:** Admins only. */ post: operations["postAttachmentsSync"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/sections": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Scanning sections * @description Which ticket types may come in at which door, for one event or every event you can see. * * **Who:** Staff, supervisors and admins. */ get: operations["getSections"]; put?: never; /** * Add a scanning section * @description **Who:** Supervisors and admins. */ post: operations["postSections"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/sections/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Remove a scanning section * @description **Who:** Admins only. */ delete: operations["deleteSectionsId"]; options?: never; head?: never; /** * Change a scanning section * @description `allowedOptionIds`, when sent, replaces its ticket types. * * **Who:** Supervisors and admins. */ patch: operations["patchSectionsId"]; trace?: never; }; "/events/{id}/costs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's planned costs * @description **Who:** Supervisors and admins. */ get: operations["getEventsIdCosts"]; put?: never; /** * Add a planned cost * @description Admins. Not on a cashed-up event. * * **Who:** Admins only. */ post: operations["postEventsIdCosts"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/costs/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Remove a planned cost * @description **Who:** Admins only. */ delete: operations["deleteCostsId"]; options?: never; head?: never; /** * Change a planned cost * @description **Who:** Admins only. */ patch: operations["patchCostsId"]; trace?: never; }; "/uploads/event-image": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload an event picture * @description Returns the path to save as the event's `picture`. * * **Who:** Supervisors and admins. */ post: operations["postUploadsEvent-image"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/uploads/logo": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload the site logo * @description Admins — or anyone during first-time setup, before any account exists. * * **Who:** Anyone. */ post: operations["postUploadsLogo"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/uploads/favicon": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload the site icon (favicon) * @description Admins — or anyone during first-time setup, before any account exists. * * **Who:** Anyone. */ post: operations["postUploadsFavicon"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/series": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every series * @description With its events (the ones you may see — a series spans campuses), followers and event count. * * **Who:** Supervisors and admins. */ get: operations["getSeries"]; put?: never; /** * Create a series * @description **Who:** Supervisors and admins. */ post: operations["postSeries"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/series/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete a series * @description Admins. Its events stay (without a series) and followers are dropped. Not once season passes have been sold. * * **Who:** Admins only. */ delete: operations["deleteSeriesId"]; options?: never; head?: never; /** * Change a series * @description **Who:** Supervisors and admins. */ patch: operations["patchSeriesId"]; trace?: never; }; "/series/by-slug/{slug}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A series' public page * @description Upcoming and past public events, season passes on sale, and whether you follow it. * * **Who:** Anyone; signed-in staff may see more. */ get: operations["getSeriesBy-slugSlug"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/series/{id}/compare": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Year on year * @description Registrations, tickets, income and attendance for each event in the series that you may see, oldest first. * * **Who:** Supervisors and admins. */ get: operations["getSeriesIdCompare"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/series/{id}/follow": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Follow a series * @description Hear about new events in it (News & announcements). * * **Who:** Any signed-in person. */ put: operations["putSeriesIdFollow"]; post?: never; /** * Stop following a series * @description **Who:** Any signed-in person. */ delete: operations["deleteSeriesIdFollow"]; options?: never; head?: never; patch?: never; trace?: never; }; "/season-passes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Season passes * @description With their events, how the price is shared between them, and how many were sold or are unpaid. * * **Who:** Supervisors and admins. */ get: operations["getSeason-passes"]; put?: never; /** * Create a season pass * @description One price for several events in a series. Campus-scoped supervisors can only include their own campuses' events. * * **Who:** Supervisors and admins. */ post: operations["postSeason-passes"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/season-passes/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete a season pass * @description Only one nobody has bought — otherwise switch it off. * * **Who:** Supervisors and admins. */ delete: operations["deleteSeason-passesId"]; options?: never; head?: never; /** * Change a season pass * @description Its events and price can't change once somebody has bought it (switch it off and make a new one). * * **Who:** Supervisors and admins. */ patch: operations["patchSeason-passesId"]; trace?: never; }; "/season-passes/{id}/buy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Buy a season pass * @description Registers you at every event on it, then answers with a checkout to pay (or issues the tickets when it's free). * * **Who:** Any signed-in person. */ post: operations["postSeason-passesIdBuy"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/season-pass-purchases/{id}/checkout": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Pay what's owed on a pass * @description **Who:** Any signed-in person. */ post: operations["postSeason-pass-purchasesIdCheckout"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/season-passes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * My season passes * @description **Who:** Any signed-in person. */ get: operations["getMeSeason-passes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/bundles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's bundle deals * @description With how often each has been used and the discount given. * * **Who:** Supervisors and admins. */ get: operations["getEventsIdBundles"]; put?: never; /** * Add a bundle deal * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdBundles"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bundles/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Remove a bundle deal * @description One that's been used is switched off instead (`switchedOff`), so registrations that got it keep their price. * * **Who:** Supervisors and admins. */ delete: operations["deleteBundlesId"]; options?: never; head?: never; /** * Change a bundle deal * @description Only what's sent changes; when a pricing field is sent the whole deal is checked again. * * **Who:** Supervisors and admins. */ patch: operations["patchBundlesId"]; trace?: never; }; "/bundles/quote": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * The bundle deals a basket gets * @description Before any coupon code — what the register page shows as you choose tickets. * * **Who:** Anyone; signed-in staff may see more. */ post: operations["postBundlesQuote"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/coupons": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Coupon codes * @description With how often each has been used and the discount given. Campus-scoped supervisors see codes for their campuses' events. * * **Who:** Supervisors and admins. */ get: operations["getCoupons"]; put?: never; /** * Create a coupon code * @description **Who:** Supervisors and admins. */ post: operations["postCoupons"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/coupons/redemptions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Coupon and bundle uses * @description For the Discounts report, newest first. * * **Who:** Supervisors and admins. */ get: operations["getCouponsRedemptions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/coupons/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One coupon code with its uses * @description **Who:** Supervisors and admins. */ get: operations["getCouponsId"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Change a coupon code * @description Only what's sent changes. Discounts already given keep their amount; a used code can't be renamed. * * **Who:** Supervisors and admins. */ patch: operations["patchCouponsId"]; trace?: never; }; "/coupons/check": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Check a coupon code against a basket * @description Always a 200: `valid` with the discount and total, or `valid: false` with why. Restricted codes need you signed in. * * **Who:** Anyone; signed-in staff may see more. */ post: operations["postCouponsCheck"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/campuses": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The active campuses * @description `enabled` false means campuses are switched off (the list is then empty). * * **Who:** Anyone. */ get: operations["getCampuses"]; put?: never; /** * Add a campus * @description **Who:** Admins only. */ post: operations["postCampuses"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/campuses/admin": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every campus (Site settings) * @description Archived ones last, with event counts and summary recipients. * * **Who:** Admins only. */ get: operations["getCampusesAdmin"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/campuses/by-slug/{slug}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A campus landing page * @description **Who:** Anyone. */ get: operations["getCampusesBy-slugSlug"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/campuses/enabled": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Switch campuses on or off * @description Off hides campus fields and filters; nothing is deleted. * * **Who:** Admins only. */ put: operations["putCampusesEnabled"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/campuses/order": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Put the campuses in order * @description **Who:** Admins only. */ put: operations["putCampusesOrder"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/campuses/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete a campus * @description Only one with no events and no staff limited to it — otherwise archive it (CONFLICT, `reason` CAMPUS_HAS_EVENTS or CAMPUS_HAS_SCOPED_STAFF). * * **Who:** Admins only. */ delete: operations["deleteCampusesId"]; options?: never; head?: never; /** * Change a campus * @description Details, summary recipients, or `archived`. * * **Who:** Admins only. */ patch: operations["patchCampusesId"]; trace?: never; }; "/campuses/{id}/audience": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Everyone at a campus * @description For the email and WhatsApp composers: people whose home campus it is, plus (`registrants=true`) people registered for its events in the last 12 months. News consent is checked when sending. * * **Who:** Supervisors and admins. */ get: operations["getCampusesIdAudience"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every registration (staff) * @description Newest first, for the events you may see. `unpaid=true` for ones still owing; `userId` for one person's. * * **Who:** Staff, supervisors and admins. */ get: operations["getRegistrations"]; put?: never; /** * Register for an event * @description Signed in, or as a guest for a free event that allows it (`guest` then required), or with a waitlist link (`waitlistToken`). * * Registering again for the same event adds to the existing registration. When nothing is owed it is marked paid and tickets are issued; otherwise pay with `POST /registrations/{id}/checkout`. * * A coupon that was valid when checked but used up a moment later is reported in `couponError`; the registration is still made. * * **Who:** Anyone; signed-in staff may see more. */ post: operations["postRegistrations"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One of my registrations * @description **Who:** Any signed-in person. */ get: operations["getRegistrationsId"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Cancel my registration * @description Not after the event has ended, and not once anything has been paid (the church can do that). Its places go to the waitlist. * * **Who:** Any signed-in person. */ post: operations["postRegistrationsIdCancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/checkout": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Pay what I owe online * @description Starts a payment with the church's provider (Yoco or PayFast) and returns where to send the person (`redirectUrl`). * * If an early-bird price ran out since the registration was made, nothing is started: `priceUpdated` is true with the new amount owing — show it, then call again. * * **Who:** Any signed-in person. */ post: operations["postRegistrationsIdCheckout"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The signed-in person * @description With what the app asks after sign-in (`newsPromptPending`, `noticePromptPending`), whether two-step sign-in is required for their role, and the campuses they're limited to (`campusScope`, null = every campus). Viewing as someone else never prompts. * * **Who:** Any signed-in person. */ get: operations["getMe"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Change my details * @description Only what is sent changes. A new `password` needs `currentPassword`; it sends a security notice and stops other devices skipping the 2FA code. The answer has a fresh `token` (the old one keeps working). * * **Who:** Any signed-in person. */ patch: operations["patchMe"]; trace?: never; }; "/me/registrations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * My registrations * @description Newest first. By default only ones for events that have not ended, and not cancelled; `past=true` lists everything. * * **Who:** Any signed-in person. */ get: operations["getMeRegistrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/full": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A registration with everything on it * @description Items and prices, payments, coupons and bundles, named attendees, form answers and the total due. * * The owner, a named attendee or staff — or anyone with the link when not signed in (registration ids can't be guessed). Attendees' contact details are only shown to the payer and staff. * * **Who:** Anyone; signed-in staff may see more. */ get: operations["getRegistrationsIdFull"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/registrations/full": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * My registrations with everything on them * @description What the dashboard shows: as `/registrations/{id}/full`, newest first, with the event and its form. Only upcoming ones unless `past=true`. * * **Who:** Any signed-in person. */ get: operations["getMeRegistrationsFull"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Change the tickets on a registration * @description The whole list of items it should have. Added places need stock and are priced now; places already paid for keep their price, and nothing goes below tickets already issued or the amount paid. * * Not for registrations made with a season pass, nor once the event has ended or is closed. Staff can add kids and volunteer places; owners can only keep or lower them. * * **Who:** Any signed-in person. */ put: operations["putRegistrationsIdItems"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/invoice": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send me the invoice again * @description **Who:** Any signed-in person. */ post: operations["postRegistrationsIdInvoice"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/coupon": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Apply a coupon code * @description By the owner, or by staff on their behalf (logged). Not on season pass registrations. * * **Who:** Any signed-in person. */ post: operations["postRegistrationsIdCoupon"]; /** * Take a coupon code off * @description Staff. Its use is freed. Not once a ticket on it has been scanned; unused tickets are withdrawn if it's no longer paid. * * **Who:** Staff, supervisors and admins. */ delete: operations["deleteRegistrationsIdCoupon"]; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/attendees": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Name the people on a registration * @description The whole list: attendees left out are removed (not once their ticket has been scanned). `ticketDelivery` says who gets the tickets. * * **Who:** Any signed-in person. */ put: operations["putRegistrationsIdAttendees"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/attendees/{attendeeId}/form-link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send an attendee their form * @description A link to fill in their own attendee form, by email and/or WhatsApp. * * **Who:** Any signed-in person. */ post: operations["postRegistrationsIdAttendeesAttendeeIdForm-link"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/form-draft": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Attendee forms saved part-way * @description **Who:** Anyone; signed-in staff may see more. */ get: operations["getRegistrationsIdForm-draft"]; /** * Save attendee forms part-way * @description Kept for the registration's owner (also when staff save it), until the forms are submitted. * * **Who:** Anyone; signed-in staff may see more. */ put: operations["putRegistrationsIdForm-draft"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/form-responses": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Replace the attendee forms * @description Supervisors: every response on the registration is replaced by these. * * **Who:** Supervisors and admins. */ put: operations["putRegistrationsIdForm-responses"]; /** * Submit attendee forms * @description One response per main ticket at most; each named attendee answers once. Tickets are issued once it's paid and the forms are in. * * **Who:** Anyone; signed-in staff may see more. */ post: operations["postRegistrationsIdForm-responses"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/registrations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's registrations * @description Oldest first, with tickets, payments and attendees. `search` matches the name, email or phone. * * **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdRegistrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Set a registration's status * @description Staff. `paid` issues and sends the tickets; leaving `paid` withdraws unused tickets (refused once one has been scanned); `cancelled` frees its places for the waitlist. * * **Who:** Staff, supervisors and admins. */ patch: operations["patchRegistrationsIdStatus"]; trace?: never; }; "/registrations/manual": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Register someone (at the door, by phone) * @description Supervisors. Finds the person by email or phone (refused when those are two different accounts) or makes an account and sends them an activation link (`skipActivationNotice` to not). * * Added to their existing registration for the event if they have one. Free ones are marked paid and get their tickets; otherwise they're sent a link to pay. * * **Who:** Supervisors and admins. */ post: operations["postRegistrationsManual"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/bulk": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Do one thing to many registrations * @description `markPaid`, `cancel`, `moveOption`, `allocate` or `message`, for up to 500 you may manage. Each is done on its own: the answer lists what worked and what didn't. * * **Who:** Supervisors and admins. */ post: operations["postRegistrationsBulk"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/providers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The payment providers switched on * @description **Who:** Anyone. */ get: operations["getPaymentsProviders"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/providers/settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Payment provider settings * @description Admins. Keys are masked. * * **Who:** Admins only. */ get: operations["getPaymentsProvidersSettings"]; /** * Change payment provider settings * @description **Who:** Admins only. */ put: operations["putPaymentsProvidersSettings"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/open-checkouts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Checkouts started but not finished * @description **Who:** Supervisors and admins. */ get: operations["getPaymentsOpen-checkouts"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/open-checkouts/check": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Ask the provider about open checkouts * @description Records any that were paid (for when a webhook was missed). * * **Who:** Supervisors and admins. */ post: operations["postPaymentsOpen-checkoutsCheck"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/stats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Payment totals * @description **Who:** Admins only. */ get: operations["getPaymentsStats"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every payment * @description For the events you may see. `page` and `limit` page it (otherwise everything); see v1 for the filters it takes. * * **Who:** Supervisors and admins. */ get: operations["getPayments"]; put?: never; /** * Record a payment * @description Cash, card, EFT or other, against a registration or (a donation) an event. Paid in full issues and sends the tickets. * * **Who:** Supervisors and admins. */ post: operations["postPayments"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/refunds": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Refund a payment * @description **Who:** Supervisors and admins. */ post: operations["postPaymentsRefunds"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/donations/assign": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Put a donation towards a registration * @description **Who:** Supervisors and admins. */ post: operations["postPaymentsDonationsAssign"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/donations/unassign": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Take a donation back off a registration * @description **Who:** Supervisors and admins. */ post: operations["postPaymentsDonationsUnassign"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/donations/checkout": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Give to an event * @description Starts a checkout for a donation of `amount` to `eventId`; answers where to send the person (`redirectUrl`). * * **Who:** Any signed-in person. */ post: operations["postDonationsCheckout"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/payments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * My payments * @description **Who:** Any signed-in person. */ get: operations["getMePayments"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One payment * @description **Who:** Any signed-in person. */ get: operations["getPaymentsId"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/{id}/receipt": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send the receipt again * @description **Who:** Any signed-in person. */ post: operations["postPaymentsIdReceipt"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/payments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A registration's payments * @description **Who:** Any signed-in person. */ get: operations["getRegistrationsIdPayments"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/payment-link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Make a link to pay * @description Supervisors: a checkout for `amount` (part of what's owed) for someone else to pay. Answers `redirectUrl` (the link) — or `priceUpdated` when an early-bird price ran out. * * **Who:** Supervisors and admins. */ post: operations["postRegistrationsIdPayment-link"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/payment-link/send": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send someone a link to pay * @description By email and/or WhatsApp, for what's still owing. * * **Who:** Supervisors and admins. */ post: operations["postRegistrationsIdPayment-linkSend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/payments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's payments * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdPayments"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payment-links/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A pay page * @description What a payment link shows: what's owed and the providers to pay with. The id in the link is the credential. * * **Who:** Anyone. */ get: operations["getPayment-linksId"]; put?: never; /** * Pay from a pay page * @description Starts a checkout with the chosen provider; answers where to send the person. * * **Who:** Anyone. */ post: operations["postPayment-linksId"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/cashups/audit": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Cash-up history * @description **Who:** Supervisors and admins. */ get: operations["getCashupsAudit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/cashup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's cash-up * @description Income by method, costs, what each drawer should hold, and the saved draft. * * **Who:** Supervisors and admins. */ get: operations["getEventsIdCashup"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/cashup/cash-by-user": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Cash taken by each person * @description **Who:** Supervisors and admins. */ get: operations["getEventsIdCashupCash-by-user"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/cashup/person-cash/{userId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Count one person's cash * @description **Who:** Supervisors and admins. */ put: operations["putEventsIdCashupPerson-cashUserId"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/cashup/draft": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Save the cash-up as a draft * @description **Who:** Admins only. */ put: operations["putEventsIdCashupDraft"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/cashup/close": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Close the event * @description Admins. Nothing about the event's money can change until it's reopened. * * **Who:** Admins only. */ post: operations["postEventsIdCashupClose"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/cashup/reopen": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Reopen a closed event * @description **Who:** Admins only. */ post: operations["postEventsIdCashupReopen"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/cashup-lines/{id}/pending": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Settle a pending cash-up line * @description **Who:** Admins only. */ post: operations["postCashup-linesIdPending"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/provider-transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Transactions from Yoco and PayFast * @description **Who:** Supervisors and admins. */ get: operations["getProvider-transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/provider-transactions/unreconciled": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Provider transactions not matched yet * @description **Who:** Supervisors and admins. */ get: operations["getProvider-transactionsUnreconciled"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/provider-transactions/{id}/reconcile": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Match a provider transaction to a registration * @description **Who:** Supervisors and admins. */ post: operations["postProvider-transactionsIdReconcile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/provider-transactions/{id}/ignore": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Ignore a provider transaction * @description **Who:** Supervisors and admins. */ post: operations["postProvider-transactionsIdIgnore"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/waitlist": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Join a sold-out event's waitlist * @description Signed in, or with a name and email or phone. When places free up, people are offered them in order. * * **Who:** Anyone; signed-in staff may see more. */ post: operations["postWaitlist"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/waitlist": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Waitlists I'm on * @description **Who:** Any signed-in person. */ get: operations["getMeWaitlist"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/waitlist/claims/{token}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A waitlist offer * @description What an offer link shows (the token is the credential). Register with `waitlistToken` to take it. * * **Who:** Anyone. */ get: operations["getWaitlistClaimsToken"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/waitlist": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's waitlist * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdWaitlist"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/waitlist/{id}/offer": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Offer someone their places now * @description **Who:** Supervisors and admins. */ post: operations["postWaitlistIdOffer"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/waitlist/{id}/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move someone up or down the waitlist * @description **Who:** Supervisors and admins. */ post: operations["postWaitlistIdMove"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/waitlist/{id}/remove": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Take someone off the waitlist * @description **Who:** Supervisors and admins. */ post: operations["postWaitlistIdRemove"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/waitlist/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Leave a waitlist * @description **Who:** Any signed-in person. */ delete: operations["deleteWaitlistId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/sponsorship": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Sponsoring places at an event * @description Whether it's on, and the suggested amounts. * * **Who:** Anyone. */ get: operations["getEventsIdSponsorship"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/sponsorship/pool": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The sponsorship pool * @description What's been given and what's been used. * * **Who:** Supervisors and admins. */ get: operations["getEventsIdSponsorshipPool"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/sponsorships/checkout": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Give towards places * @description Starts a checkout; answers where to send the person. * * **Who:** Anyone; signed-in staff may see more. */ post: operations["postSponsorshipsCheckout"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/consent": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Parental consent for an event * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdConsent"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/consent/medical": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Medical notes from consent forms * @description **Who:** Supervisors and admins. */ get: operations["getEventsIdConsentMedical"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/consent/resend-pending": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Remind everyone who hasn't answered * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdConsentResend-pending"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/consent/rerequest": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Ask for consent again * @description After the consent wording changed. * * **Who:** Supervisors and admins. */ post: operations["postEventsIdConsentRerequest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/consent-requests/{id}/resend": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send a consent request again * @description **Who:** Any signed-in person. */ post: operations["postConsent-requestsIdResend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/consent/{token}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A consent form * @description What the link in a consent request shows (the token is the parent's credential). * * **Who:** Anyone. */ get: operations["getConsentToken"]; put?: never; /** * Answer a consent form * @description **Who:** Anyone. */ post: operations["postConsentToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/form-responses": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Attendee form answers * @description For an event (`eventId`) or a registration (`registrationId`), for events you may see. * * **Who:** Staff, supervisors and admins. */ get: operations["getForm-responses"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/feedback/summary": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Feedback across events * @description **Who:** Supervisors and admins. */ get: operations["getFeedbackSummary"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/feedback-forms/{token}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A feedback form * @description What the link sent after an event shows (the token is the credential). * * **Who:** Anyone. */ get: operations["getFeedback-formsToken"]; put?: never; /** * Answer a feedback form * @description **Who:** Anyone. */ post: operations["postFeedback-formsToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/feedback": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's feedback set-up and answers * @description **Who:** Supervisors and admins. */ get: operations["getEventsIdFeedback"]; /** * Set up an event's feedback form * @description **Who:** Supervisors and admins. */ put: operations["putEventsIdFeedback"]; post?: never; /** * Remove an event's feedback form * @description **Who:** Supervisors and admins. */ delete: operations["deleteEventsIdFeedback"]; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/feedback/send-now": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send the feedback form now * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdFeedbackSend-now"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/tickets": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * My tickets * @description Including ones transferred to me. * * **Who:** Any signed-in person. */ get: operations["getMeTickets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/tickets/email": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send me my tickets * @description For a registration (`registrationId`) or chosen tickets (`ticketIds`), by email and/or WhatsApp (`channel`). * * **Who:** Any signed-in person. */ post: operations["postMeTicketsEmail"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets/scans/recent": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Recent scans * @description **Who:** Staff, supervisors and admins. */ get: operations["getTicketsScansRecent"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets/scans/stats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Scan counts * @description **Who:** Staff, supervisors and admins. */ get: operations["getTicketsScansStats"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets/send": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send tickets to someone * @description Staff: a registration's tickets (or chosen ones) to an email address or phone number. * * **Who:** Staff, supervisors and admins. */ post: operations["postTicketsSend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets/generate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Issue a registration's tickets * @description **Who:** Supervisors and admins. */ post: operations["postTicketsGenerate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets/email-sent": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mark tickets as emailed * @description **Who:** Admins only. */ post: operations["postTicketsEmail-sent"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every ticket * @description **Who:** Supervisors and admins. */ get: operations["getTickets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets/qr/{qrCode}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The ticket for a QR code * @description Without checking it in (that's POST /checkin/{qrCode}). * * **Who:** Staff, supervisors and admins. */ get: operations["getTicketsQrQrCode"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/tickets": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's tickets * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdTickets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/ticket-transfers/{token}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A ticket someone is giving you * @description What the transfer link shows (the token is the credential). * * **Who:** Anyone. */ get: operations["getTicket-transfersToken"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/ticket-transfers/{token}/accept": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Accept a ticket * @description **Who:** Anyone. */ post: operations["postTicket-transfersTokenAccept"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/ticket-transfers/{token}/decline": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Decline a ticket * @description **Who:** Anyone. */ post: operations["postTicket-transfersTokenDecline"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One ticket * @description **Who:** Any signed-in person. */ get: operations["getTicketsId"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets/{id}/transfer": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Give a ticket to someone * @description Sends them a link to accept it; the ticket is theirs once they do. * * **Who:** Any signed-in person. */ post: operations["postTicketsIdTransfer"]; /** * Cancel a ticket transfer * @description **Who:** Any signed-in person. */ delete: operations["deleteTicketsIdTransfer"]; options?: never; head?: never; patch?: never; trace?: never; }; "/tickets/{id}/transfers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A ticket's transfers * @description **Who:** Any signed-in person. */ get: operations["getTicketsIdTransfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scan-locks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Devices scanning offline for an event * @description **Who:** Staff, supervisors and admins. */ get: operations["getScan-locks"]; put?: never; /** * Take tickets offline on this device * @description Locks the chosen tickets to this device until it syncs or releases them. * * **Who:** Staff, supervisors and admins. */ post: operations["postScan-locks"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scan-locks/reports": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Offline sync reports to review * @description **Who:** Supervisors and admins. */ get: operations["getScan-locksReports"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scan-locks/reports/{id}/review": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mark a sync report reviewed * @description **Who:** Supervisors and admins. */ post: operations["postScan-locksReportsIdReview"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scan-locks/{id}/snapshot": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The tickets a device took offline * @description **Who:** Staff, supervisors and admins. */ get: operations["getScan-locksIdSnapshot"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scan-locks/{id}/sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload scans made offline * @description **Who:** Staff, supervisors and admins. */ post: operations["postScan-locksIdSync"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scan-locks/{id}/force-release": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Release a lost device's tickets * @description **Who:** Supervisors and admins. */ post: operations["postScan-locksIdForce-release"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scan-locks/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Release tickets back online * @description **Who:** Staff, supervisors and admins. */ delete: operations["deleteScan-locksId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/certificates/verify/{code}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Check a certificate is genuine * @description **Who:** Anyone. */ get: operations["getCertificatesVerifyCode"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/certificates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * My certificates * @description **Who:** Any signed-in person. */ get: operations["getMeCertificates"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/certificates/preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Preview a certificate template * @description **Who:** Supervisors and admins. */ post: operations["postCertificatesPreview"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/certificates/{id}/pdf": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download a certificate * @description Its owner, or staff. * * **Who:** Any signed-in person. */ get: operations["getCertificatesIdPdf"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/certificates/{id}/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Withdraw a certificate * @description **Who:** Supervisors and admins. */ post: operations["postCertificatesIdRevoke"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/attendance": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's attendance register * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdAttendance"]; put?: never; /** * Mark attendance * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdAttendance"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/attendance/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The register as a file * @description `format=pdf` or `xlsx`. * * **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdAttendanceExport"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/certificates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Issue certificates * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdCertificates"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/certificates/send": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send certificates * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdCertificatesSend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/certificates.pdf": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every certificate for an event, as one PDF * @description **Who:** Supervisors and admins. */ get: operations["getEventsIdCertificates.pdf"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/allocation-groups": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Groups I lead * @description **Who:** Staff, supervisors and admins. */ get: operations["getMeAllocation-groups"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/allocations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's allocation board * @description **Who:** Supervisors and admins. */ get: operations["getEventsIdAllocations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/allocation-sets": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Start a set of groups * @description **Who:** Supervisors and admins. */ post: operations["postAllocation-sets"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/allocation-sets/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete a set * @description **Who:** Supervisors and admins. */ delete: operations["deleteAllocation-setsId"]; options?: never; head?: never; /** * Change a set * @description **Who:** Supervisors and admins. */ patch: operations["patchAllocation-setsId"]; trace?: never; }; "/allocation-sets/{id}/lists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A set's lists (who is in each group) * @description **Who:** Supervisors and admins. */ get: operations["getAllocation-setsIdLists"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/allocation-sets/{id}/groups": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add a group * @description **Who:** Supervisors and admins. */ post: operations["postAllocation-setsIdGroups"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/allocation-sets/{id}/assignments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Put people in groups * @description **Who:** Supervisors and admins. */ put: operations["putAllocation-setsIdAssignments"]; post?: never; /** * Empty every group * @description **Who:** Supervisors and admins. */ delete: operations["deleteAllocation-setsIdAssignments"]; options?: never; head?: never; patch?: never; trace?: never; }; "/allocation-sets/{id}/auto": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Fill the groups automatically * @description **Who:** Supervisors and admins. */ post: operations["postAllocation-setsIdAuto"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/allocation-groups/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete a group * @description **Who:** Supervisors and admins. */ delete: operations["deleteAllocation-groupsId"]; options?: never; head?: never; /** * Change a group * @description **Who:** Supervisors and admins. */ patch: operations["patchAllocation-groupsId"]; trace?: never; }; "/corrections/events/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's registrations, with what needs putting right * @description Every registration that isn't cancelled — closed and past events too — with its balance, forms still to fill in, tickets and check-ins. * * **Who:** Admins only. */ get: operations["getCorrectionsEventsId"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/corrections/events/{id}/issue-missing": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Issue every missing ticket at an event * @description For each paid registration (or one released unpaid) without all its tickets. Attendee forms still outstanding are left for later. * * **Who:** Admins only. */ post: operations["postCorrectionsEventsIdIssue-missing"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/corrections/registrations/{id}/tickets": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Issue a registration's tickets now * @description `skipForm` leaves the attendee form for later; `payLater` issues them before it's paid (the balance is still owed). * * **Who:** Admins only. */ post: operations["postCorrectionsRegistrationsIdTickets"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/corrections/registrations/{id}/complimentary": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Make it free * @description What's still owed is written off as a complimentary discount (income stays what was really paid), it's marked paid and its tickets are issued. Not on a closed event. * * **Who:** Admins only. */ post: operations["postCorrectionsRegistrationsIdComplimentary"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/corrections/tickets/{id}/check-in": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Check a ticket in (or undo it) after the fact * @description Any time — after the event or session, or once the event is closed. `present: false` undoes the check-in for that session. Recorded as a manual check-in; no message is sent. * * **Who:** Admins only. */ post: operations["postCorrectionsTicketsIdCheck-in"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/registrations/{id}/form-later": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Fill in the attendee form later * @description At the door: the tickets stop waiting for the required attendee form (issued now if it's paid) and the payer is sent a link to fill it in (`notify: false` to not). * * **Who:** Staff, supervisors and admins. */ post: operations["postRegistrationsIdForm-later"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/family": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * My family * @description Children, the adults who may collect them, and the family QR code. * * **Who:** Any signed-in person. */ get: operations["getMeFamily"]; put?: never; /** * Start my family * @description **Who:** Any signed-in person. */ post: operations["postMeFamily"]; /** * Leave my family * @description **Who:** Any signed-in person. */ delete: operations["deleteMeFamily"]; options?: never; head?: never; /** * Rename my family * @description **Who:** Any signed-in person. */ patch: operations["patchMeFamily"]; trace?: never; }; "/me/family/children": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add a child * @description **Who:** Any signed-in person. */ post: operations["postMeFamilyChildren"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/family/children/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Change a child * @description **Who:** Any signed-in person. */ put: operations["putMeFamilyChildrenId"]; post?: never; /** * Remove a child * @description **Who:** Any signed-in person. */ delete: operations["deleteMeFamilyChildrenId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/me/family/adults": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add an adult who may collect * @description **Who:** Any signed-in person. */ post: operations["postMeFamilyAdults"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/family/adults/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Change an adult * @description **Who:** Any signed-in person. */ put: operations["putMeFamilyAdultsId"]; post?: never; /** * Remove an adult * @description **Who:** Any signed-in person. */ delete: operations["deleteMeFamilyAdultsId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/kids/setup-events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Events that can have kids check-in * @description **Who:** Supervisors and admins. */ get: operations["getKidsSetup-events"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/kids/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Events with kids check-in * @description **Who:** Staff, supervisors and admins. */ get: operations["getKidsEvents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's kids check-in set-up * @description **Who:** Supervisors and admins. */ get: operations["getEventsIdKidsSettings"]; /** * Set up kids check-in * @description **Who:** Supervisors and admins. */ put: operations["putEventsIdKidsSettings"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/board": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Who is checked in, by room * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdKidsBoard"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/families": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Find a family * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdKidsFamilies"]; put?: never; /** * Register a family at the desk * @description **Who:** Staff, supervisors and admins. */ post: operations["postEventsIdKidsFamilies"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/families/qr/{token}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The family for a QR code * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdKidsFamiliesQrToken"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/families/{familyId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One family * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdKidsFamiliesFamilyId"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/families/{familyId}/parents": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add a parent at the desk * @description **Who:** Staff, supervisors and admins. */ post: operations["postEventsIdKidsFamiliesFamilyIdParents"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/families/{familyId}/children": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add a child at the desk * @description **Who:** Staff, supervisors and admins. */ post: operations["postEventsIdKidsFamiliesFamilyIdChildren"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/families/{familyId}/children/{childId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Change a child at the desk * @description **Who:** Staff, supervisors and admins. */ put: operations["putEventsIdKidsFamiliesFamilyIdChildrenChildId"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/families/{familyId}/adults": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add an adult at the desk * @description **Who:** Staff, supervisors and admins. */ post: operations["postEventsIdKidsFamiliesFamilyIdAdults"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/check-in": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Check children in * @description Answers the collection code and labels to print. * * **Who:** Staff, supervisors and admins. */ post: operations["postEventsIdKidsCheck-in"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/check-out": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Check children out * @description With the collection code; refused for someone not allowed to collect. * * **Who:** Staff, supervisors and admins. */ post: operations["postEventsIdKidsCheck-out"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/code/{code}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Who a collection code is for * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdKidsCodeCode"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/duty": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Say which room I'm on * @description **Who:** Staff, supervisors and admins. */ post: operations["postEventsIdKidsDuty"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/offline": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Everything the desk needs offline * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdKidsOffline"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/kids/sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload check-ins made offline * @description **Who:** Staff, supervisors and admins. */ post: operations["postEventsIdKidsSync"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/kids/check-ins/{id}/override": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Let someone not on the list collect * @description Logged, with the reason. * * **Who:** Staff, supervisors and admins. */ post: operations["postKidsCheck-insIdOverride"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/kids/check-ins/{id}/page": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Page a child's parent * @description **Who:** Staff, supervisors and admins. */ post: operations["postKidsCheck-insIdPage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/kids/check-ins/{id}/room": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Move a child to another room * @description **Who:** Staff, supervisors and admins. */ put: operations["putKidsCheck-insIdRoom"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/kids/alerts/{id}/resolve": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Resolve an alert * @description **Who:** Staff, supervisors and admins. */ post: operations["postKidsAlertsIdResolve"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/volunteering": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Where I'm serving * @description **Who:** Any signed-in person. */ get: operations["getMeVolunteering"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/volunteer-roles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Roles I can serve in at an event * @description **Who:** Any signed-in person. */ get: operations["getEventsIdVolunteer-roles"]; put?: never; /** * Add a role * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdVolunteer-roles"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteer-roles/{id}/sign-up": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Sign up to serve * @description **Who:** Any signed-in person. */ post: operations["postVolunteer-rolesIdSign-up"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteer-slots/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Stop serving in a slot * @description **Who:** Any signed-in person. */ delete: operations["deleteVolunteer-slotsId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteer-slots/{id}/swap": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Ask someone to take my slot * @description **Who:** Any signed-in person. */ post: operations["postVolunteer-slotsIdSwap"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteer-swaps/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Cancel a swap request * @description **Who:** Any signed-in person. */ delete: operations["deleteVolunteer-swapsId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteer-swaps/{id}/accept": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Take someone's slot * @description **Who:** Any signed-in person. */ post: operations["postVolunteer-swapsIdAccept"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteering/check-in": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Check myself in (the event's QR code) * @description **Who:** Any signed-in person. */ post: operations["postVolunteeringCheck-in"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteering/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Events with volunteer roles * @description **Who:** Staff, supervisors and admins. */ get: operations["getVolunteeringEvents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteering/hours": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Hours served * @description **Who:** Supervisors and admins. */ get: operations["getVolunteeringHours"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/volunteers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * An event's roster * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdVolunteers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/volunteers/qr": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The self check-in QR code * @description **Who:** Staff, supervisors and admins. */ get: operations["getEventsIdVolunteersQr"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/volunteers/settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Volunteer set-up * @description **Who:** Supervisors and admins. */ get: operations["getEventsIdVolunteersSettings"]; /** * Set up volunteering * @description **Who:** Supervisors and admins. */ put: operations["putEventsIdVolunteersSettings"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteer-roles/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete a role * @description **Who:** Supervisors and admins. */ delete: operations["deleteVolunteer-rolesId"]; options?: never; head?: never; /** * Change a role * @description **Who:** Supervisors and admins. */ patch: operations["patchVolunteer-rolesId"]; trace?: never; }; "/volunteer-roles/{id}/assign": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Put someone in a role * @description **Who:** Supervisors and admins. */ post: operations["postVolunteer-rolesIdAssign"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteer-slots/{id}/check-in": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Check a volunteer in * @description **Who:** Staff, supervisors and admins. */ post: operations["postVolunteer-slotsIdCheck-in"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/volunteer-slots/{id}/remove": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Take someone off a slot * @description **Who:** Supervisors and admins. */ post: operations["postVolunteer-slotsIdRemove"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/auth/login/code/resend": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send the sign-in code again * @description **Who:** Anyone. */ post: operations["postAuthLoginCodeResend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/auth/password/forgot": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Email me a link to reset my password * @description Always the same answer, so it doesn't say whether an account has that email. Rate-limited like sign-in. * * **Who:** Anyone. */ post: operations["postAuthPasswordForgot"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/auth/password/reset": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Set a new password with a reset link * @description **Who:** Anyone. */ post: operations["postAuthPasswordReset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/auth/activate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Activate an account with its link * @description **Who:** Anyone. */ post: operations["postAuthActivate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/sessions/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Sign out everywhere else * @description **Who:** Any signed-in person. */ post: operations["postMeSessionsRevoke"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/close": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Close my account * @description Needs the password. Personal details are removed; payment records stay, anonymised. * * **Who:** Any signed-in person. */ post: operations["postMeClose"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/activity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Recent sign-ins and changes to my account * @description **Who:** Any signed-in person. */ get: operations["getMeActivity"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/verify-password": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Check my password (before a sensitive change) * @description **Who:** Any signed-in person. */ post: operations["postMeVerify-password"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/two-factor/enable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Start turning on two-step sign-in * @description Sends a code to confirm with. * * **Who:** Any signed-in person. */ post: operations["postMeTwo-factorEnable"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/two-factor/confirm": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Confirm two-step sign-in with the code * @description **Who:** Any signed-in person. */ post: operations["postMeTwo-factorConfirm"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/two-factor/disable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Turn off two-step sign-in * @description **Who:** Any signed-in person. */ post: operations["postMeTwo-factorDisable"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/users/exists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Is there an account with this email or phone? * @description **Who:** Supervisors and admins. */ get: operations["getUsersExists"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/users": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every account * @description Paged (`page`, `limit`) and searchable (`q`, `role`, `campus`, …) — see v1 for every filter. * * **Who:** Supervisors and admins. */ get: operations["getUsers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/users/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One account * @description **Who:** Admins only. */ get: operations["getUsersId"]; put?: never; post?: never; /** * Delete an account * @description **Who:** Admins only. */ delete: operations["deleteUsersId"]; options?: never; head?: never; /** * Change an account * @description Name, contact details, role, campus limits, active. * * **Who:** Admins only. */ patch: operations["patchUsersId"]; trace?: never; }; "/users/{id}/sessions/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Sign someone out everywhere * @description **Who:** Admins only. */ post: operations["postUsersIdSessionsRevoke"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/users/{id}/anonymize": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Anonymise an account * @description Admins. Personal details are removed for good; payment records stay. * * **Who:** Admins only. */ post: operations["postUsersIdAnonymize"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/event-listing": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Upcoming public events in full * @description What the site's event lists show (ticket options, prices, early-bird tiers), not paged. `campus` (id or slug) and `series` (slug) narrow it. For a paged, slimmer list use GET /events. * * **Who:** Anyone. */ get: operations["getEvent-listing"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/admin/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every event, including deactivated ones * @description **Who:** Admins only. */ get: operations["getAdminEvents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/email-attendees": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Email an event's people * @description Filtered by status or chosen people; news consent is checked. * * **Who:** Supervisors and admins. */ post: operations["postEventsIdEmail-attendees"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/email-attendees/schedule": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Schedule an email to an event's people * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdEmail-attendeesSchedule"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/whatsapp-attendees": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * WhatsApp an event's people * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdWhatsapp-attendees"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/events/{id}/whatsapp-attendees/schedule": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Schedule a WhatsApp to an event's people * @description **Who:** Supervisors and admins. */ post: operations["postEventsIdWhatsapp-attendeesSchedule"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/broadcasts/email/preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Who an email broadcast would reach * @description **Who:** Supervisors and admins. */ post: operations["postBroadcastsEmailPreview"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/broadcasts/email/send": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send an email broadcast * @description To campuses, events, roles or listed people; news consent is checked. * * **Who:** Supervisors and admins. */ post: operations["postBroadcastsEmailSend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/broadcasts/email/schedule": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Schedule an email broadcast * @description **Who:** Supervisors and admins. */ post: operations["postBroadcastsEmailSchedule"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/broadcasts/whatsapp/preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Who a WhatsApp broadcast would reach * @description **Who:** Supervisors and admins. */ post: operations["postBroadcastsWhatsappPreview"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/broadcasts/whatsapp/send": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send a WhatsApp broadcast * @description To campuses, events, roles or listed people; news consent is checked. * * **Who:** Supervisors and admins. */ post: operations["postBroadcastsWhatsappSend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/broadcasts/whatsapp/schedule": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Schedule a WhatsApp broadcast * @description **Who:** Supervisors and admins. */ post: operations["postBroadcastsWhatsappSchedule"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scheduled-messages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Scheduled emails and WhatsApps * @description **Who:** Supervisors and admins. */ get: operations["getScheduled-messages"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scheduled-messages/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Cancel a scheduled message * @description **Who:** Supervisors and admins. */ delete: operations["deleteScheduled-messagesId"]; options?: never; head?: never; /** * Change a scheduled message * @description **Who:** Supervisors and admins. */ patch: operations["patchScheduled-messagesId"]; trace?: never; }; "/automations/schedule": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Schedule an event's reminder messages * @description **Who:** Supervisors and admins. */ post: operations["postAutomationsSchedule"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/whatsapp/config": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The WhatsApp connection settings * @description **Who:** Admins only. */ get: operations["getWhatsappConfig"]; /** * Change the WhatsApp connection settings * @description **Who:** Admins only. */ put: operations["putWhatsappConfig"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/whatsapp/instance": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create the WhatsApp instance * @description **Who:** Admins only. */ post: operations["postWhatsappInstance"]; /** * Delete the WhatsApp instance * @description **Who:** Admins only. */ delete: operations["deleteWhatsappInstance"]; options?: never; head?: never; patch?: never; trace?: never; }; "/whatsapp/status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Is WhatsApp connected? * @description **Who:** Admins only. */ get: operations["getWhatsappStatus"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/whatsapp/qr": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The QR code to link a phone * @description **Who:** Admins only. */ get: operations["getWhatsappQr"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/whatsapp/request-code": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Link a phone with a code instead * @description **Who:** Admins only. */ post: operations["postWhatsappRequest-code"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/whatsapp/logout": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Unlink the phone * @description **Who:** Admins only. */ post: operations["postWhatsappLogout"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/whatsapp/start": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Start the WhatsApp session * @description **Who:** Admins only. */ post: operations["postWhatsappStart"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/whatsapp/restart": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Restart the WhatsApp session * @description **Who:** Admins only. */ post: operations["postWhatsappRestart"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/banner": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The site-wide banner * @description **Who:** Anyone. */ get: operations["getBanner"]; /** * Set the site-wide banner * @description **Who:** Supervisors and admins. */ put: operations["putBanner"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/saved-filters": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * My saved filters * @description For one list page (`page`). * * **Who:** Staff, supervisors and admins. */ get: operations["getSaved-filters"]; put?: never; /** * Save a filter * @description By name (replaces one with the same name); up to 30 per page. * * **Who:** Staff, supervisors and admins. */ post: operations["postSaved-filters"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/saved-filters/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Change a saved filter * @description **Who:** Staff, supervisors and admins. */ put: operations["putSaved-filtersId"]; post?: never; /** * Delete a saved filter * @description **Who:** Staff, supervisors and admins. */ delete: operations["deleteSaved-filtersId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/dashboard/today": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Today at a glance * @description **Who:** Staff, supervisors and admins. */ get: operations["getDashboardToday"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dashboard/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Search people, registrations and events * @description **Who:** Staff, supervisors and admins. */ get: operations["getDashboardSearch"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/stats/staff": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Staff dashboard numbers * @description **Who:** Staff, supervisors and admins. */ get: operations["getStatsStaff"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/stats/supervisor": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Supervisor dashboard numbers * @description **Who:** Supervisors and admins. */ get: operations["getStatsSupervisor"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/stats/admin": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Admin dashboard numbers * @description **Who:** Admins only. */ get: operations["getStatsAdmin"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/stats/overview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Overview numbers * @description **Who:** Supervisors and admins. */ get: operations["getStatsOverview"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/analytics/track": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Record a step on the way to registering * @description **Who:** Anyone. */ post: operations["postAnalyticsTrack"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/analytics/funnel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * How many get from viewing to paying * @description **Who:** Supervisors and admins. */ get: operations["getAnalyticsFunnel"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/reports/pdf": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * A report as a PDF * @description The report's rows and columns in the body. * * **Who:** Any signed-in person. */ post: operations["postReportsPdf"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/reports/excel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * A report as an Excel file * @description **Who:** Any signed-in person. */ post: operations["postReportsExcel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/reports/email": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Email a report as a PDF * @description **Who:** Any signed-in person. */ post: operations["postReportsEmail"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/reports/whatsapp": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * WhatsApp a report as a PDF * @description **Who:** Any signed-in person. */ post: operations["postReportsWhatsapp"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/privacy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * My privacy settings * @description News consent, open requests, and whether there's a privacy notice to accept. * * **Who:** Any signed-in person. */ get: operations["getMePrivacy"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/privacy/news": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Choose whether to get news * @description **Who:** Any signed-in person. */ put: operations["putMePrivacyNews"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/privacy/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download everything held about me * @description `format=pdf` or JSON (the default). * * **Who:** Any signed-in person. */ get: operations["getMePrivacyExport"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/privacy/requests": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Ask for my data to be corrected or deleted * @description **Who:** Any signed-in person. */ post: operations["postMePrivacyRequests"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/privacy/notice/accept": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Accept the privacy notice * @description **Who:** Any signed-in person. */ post: operations["postMePrivacyNoticeAccept"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/notice": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The published privacy notice * @description **Who:** Anyone. */ get: operations["getPrivacyNotice"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/unsubscribe/{token}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * What an unsubscribe link is for * @description The token in the link is the credential. * * **Who:** Anyone. */ get: operations["getUnsubscribeToken"]; put?: never; /** * Unsubscribe with a link * @description **Who:** Anyone. */ post: operations["postUnsubscribeToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/requests": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Data requests * @description `status=open` (default), `closed` or `all`. * * **Who:** Admins only. */ get: operations["getPrivacyRequests"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/requests/{id}/complete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mark a data request done * @description **Who:** Admins only. */ post: operations["postPrivacyRequestsIdComplete"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/requests/{id}/reject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Turn down a data request * @description **Who:** Admins only. */ post: operations["postPrivacyRequestsIdReject"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/notice/draft": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The privacy notice being drafted * @description **Who:** Admins only. */ get: operations["getPrivacyNoticeDraft"]; /** * Save the draft notice * @description **Who:** Admins only. */ put: operations["putPrivacyNoticeDraft"]; post?: never; /** * Throw the draft away * @description **Who:** Admins only. */ delete: operations["deletePrivacyNoticeDraft"]; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/notice/publish": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Publish the draft notice * @description Everyone is asked to accept it at their next sign-in. * * **Who:** Admins only. */ post: operations["postPrivacyNoticePublish"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/notice/builtin-reviewed": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mark the built-in notice as reviewed * @description **Who:** Admins only. */ post: operations["postPrivacyNoticeBuiltin-reviewed"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/operators": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Who processes personal information for the church * @description **Who:** Admins only. */ get: operations["getPrivacyOperators"]; put?: never; /** * Add an operator * @description **Who:** Admins only. */ post: operations["postPrivacyOperators"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/operators/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Change an operator * @description **Who:** Admins only. */ put: operations["putPrivacyOperatorsId"]; post?: never; /** * Remove an operator * @description **Who:** Admins only. */ delete: operations["deletePrivacyOperatorsId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/consent-log": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Consent given and withdrawn * @description **Who:** Admins only. */ get: operations["getPrivacyConsent-log"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/access-log": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Who looked at sensitive information * @description **Who:** Admins only. */ get: operations["getPrivacyAccess-log"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/readiness": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * POPIA checklist * @description **Who:** Admins only. */ get: operations["getPrivacyReadiness"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/retention": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * How long information is kept * @description **Who:** Admins only. */ get: operations["getPrivacyRetention"]; /** * Change how long information is kept * @description **Who:** Admins only. */ put: operations["putPrivacyRetention"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/retention/run": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Apply the retention rules now * @description **Who:** Admins only. */ post: operations["postPrivacyRetentionRun"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/breaches": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Recorded data breaches * @description **Who:** Admins only. */ get: operations["getPrivacyBreaches"]; put?: never; /** * Record a data breach * @description **Who:** Admins only. */ post: operations["postPrivacyBreaches"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/privacy/breaches/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Update a data breach * @description **Who:** Admins only. */ put: operations["putPrivacyBreachesId"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/admin/audit-log": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The audit log * @description **Who:** Admins only. */ get: operations["getAdminAudit-log"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/admin/jobs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Background jobs * @description **Who:** Admins only. */ get: operations["getAdminJobs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/admin/jobs/{name}/run": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Run a background job now * @description **Who:** Admins only. */ post: operations["postAdminJobsNameRun"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/admin/impersonation-sessions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Times admins viewed the site as someone else * @description **Who:** Admins only. */ get: operations["getAdminImpersonation-sessions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/admin/impersonate/{userId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * View the site as someone (read-only) * @description Answers a token for a read-only session, logged. * * **Who:** Admins only. */ post: operations["postAdminImpersonateUserId"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/impersonation": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The viewing-as session I'm in, if any * @description **Who:** Any signed-in person. */ get: operations["getMeImpersonation"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/impersonation/end": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Stop viewing as someone * @description **Who:** Any signed-in person. */ post: operations["postMeImpersonationEnd"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/impersonation/log": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Record a page viewed while viewing as someone * @description **Who:** Any signed-in person. */ post: operations["postMeImpersonationLog"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Public site settings * @description Name, branding, contact details and what's switched on. * * **Who:** Anyone. */ get: operations["getSettings"]; /** * Change settings * @description **Who:** Admins only. */ put: operations["putSettings"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/settings/all": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Every setting * @description Admins. Secrets are masked. * * **Who:** Admins only. */ get: operations["getSettingsAll"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/settings/test-smtp": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send a test email * @description **Who:** Admins only. */ post: operations["postSettingsTest-smtp"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/setup/needed": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Does the site still need setting up? * @description **Who:** Anyone. */ get: operations["getSetupNeeded"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/setup/register": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create the first admin * @description Only while no account exists. * * **Who:** Anyone. */ post: operations["postSetupRegister"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Finish first-run set-up * @description **Who:** Admins only. */ post: operations["postSetup"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/hub/status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * The connection to the provider's Hub * @description **Who:** Admins only. */ get: operations["getHubStatus"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/hub/connect": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Connect to the Hub * @description **Who:** Admins only. */ post: operations["postHubConnect"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/hub/heartbeat": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Check in with the Hub now * @description **Who:** Admins only. */ post: operations["postHubHeartbeat"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/hub/update-request": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Ask for the update to be installed * @description **Who:** Admins only. */ post: operations["postHubUpdate-request"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/hub/update-request/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Withdraw the update request * @description **Who:** Admins only. */ post: operations["postHubUpdate-requestCancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/hub/update-snooze": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Remind me about the update later * @description **Who:** Admins only. */ post: operations["postHubUpdate-snooze"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/hub/notices": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Notices from the provider * @description **Who:** Supervisors and admins. */ get: operations["getHubNotices"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/outbound-webhooks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Webhooks the site sends * @description **Who:** Admins only. */ get: operations["getOutbound-webhooks"]; put?: never; /** * Add a webhook * @description Answers its signing secret once. * * **Who:** Admins only. */ post: operations["postOutbound-webhooks"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/outbound-webhook-deliveries/{id}/resend": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send a delivery again * @description **Who:** Admins only. */ post: operations["postOutbound-webhook-deliveriesIdResend"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/outbound-webhooks/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Remove a webhook * @description **Who:** Admins only. */ delete: operations["deleteOutbound-webhooksId"]; options?: never; head?: never; /** * Change a webhook * @description **Who:** Admins only. */ patch: operations["patchOutbound-webhooksId"]; trace?: never; }; "/outbound-webhooks/{id}/rotate-secret": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Give a webhook a new signing secret * @description **Who:** Admins only. */ post: operations["postOutbound-webhooksIdRotate-secret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/outbound-webhooks/{id}/test": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send a test delivery * @description **Who:** Admins only. */ post: operations["postOutbound-webhooksIdTest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/outbound-webhooks/{id}/deliveries": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * A webhook's recent deliveries * @description **Who:** Admins only. */ get: operations["getOutbound-webhooksIdDeliveries"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/backups": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Database backups * @description **Who:** Admins only. */ get: operations["getBackups"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/backups/run": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Back up the database now * @description **Who:** Admins only. */ post: operations["postBackupsRun"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/backups/{filename}/download": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download a backup * @description **Who:** Admins only. */ get: operations["getBackupsFilenameDownload"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/yoco/config": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Yoco settings * @description Keys are masked. * * **Who:** Admins only. */ get: operations["getPaymentsYocoConfig"]; /** * Change Yoco settings * @description **Who:** Admins only. */ put: operations["putPaymentsYocoConfig"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/yoco/webhooks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Webhooks registered with Yoco * @description **Who:** Admins only. */ get: operations["getPaymentsYocoWebhooks"]; put?: never; /** * Register a webhook with Yoco * @description **Who:** Admins only. */ post: operations["postPaymentsYocoWebhooks"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/yoco/webhooks/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Remove a webhook from Yoco * @description **Who:** Admins only. */ delete: operations["deletePaymentsYocoWebhooksId"]; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/payfast/config": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * PayFast settings * @description The passphrase is masked. * * **Who:** Admins only. */ get: operations["getPaymentsPayfastConfig"]; /** * Change PayFast settings * @description **Who:** Admins only. */ put: operations["putPaymentsPayfastConfig"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/payments/payfast/test": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Check the PayFast details work * @description **Who:** Admins only. */ post: operations["postPaymentsPayfastTest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/checkin/{qrCode}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Look a ticket up before checking it in * @description Who it is for, how many are left to check in (for today's session on multi-day events, or `sessionId`), and parental consent. Nothing is changed. * * **Who:** Staff, supervisors and admins. */ get: operations["getCheckinQrCode"]; put?: never; /** * Check a ticket in * @description Checks in everyone left on the ticket, or `people`. Every normal result is a 200 with an `outcome`: * * `checked_in`, `already_used`, `consent_required` (a supervisor can resend with `overrideConsent`, which is logged), `wrong_event`, `wrong_section`, `section_not_found`, `no_session` (multi-day: nothing open now), `locked` (offline-locked to another device) or `transferred` (handed on; `message` says to whom). * * An unknown code is `NOT_FOUND`. * * **Who:** Staff, supervisors and admins. */ post: operations["postCheckinQrCode"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/auth/signup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create an account * @description Signs the new account in straight away. `acceptTerms` must be true (the Terms of Use and Privacy Policy); `newsOptIn` is the unticked "News & announcements" box. * * **Who:** Anyone. */ post: operations["postAuthSignup"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/auth/login": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Log in * @description With an email address or phone number. Five wrong passwords lock the account for five minutes (`RATE_LIMITED`). * * With two-factor authentication (always for supervisors and admins), the answer is `code_required`: a code was sent by email or WhatsApp — finish with `POST /auth/login/code`. * * **Who:** Anyone. */ post: operations["postAuthLogin"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/auth/login/code": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Finish logging in with the code * @description **Who:** Anyone. */ post: operations["postAuthLoginCode"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { Error: { error: { /** @enum {string} */ code: "VALIDATION_FAILED" | "UNAUTHENTICATED" | "FORBIDDEN" | "NOT_FOUND" | "CONFLICT" | "RATE_LIMITED" | "READ_ONLY" | "INTERNAL"; message: string; /** @description Per-field problems (VALIDATION_FAILED only) */ fields?: { [key: string]: string; }; /** @description A more specific cause when there is one, e.g. TWO_FACTOR_REQUIRED, IMPERSONATION_ENDED, LICENCE_READ_ONLY, OTHER_CAMPUS */ reason?: string; }; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { getEventsManage: { parameters: { query?: { /** @description Include events that have ended */ past?: "true" | "false"; /** @description Include deactivated events */ inactive?: "true" | "false"; /** @description Include cashed-up events (default true) */ closed?: "true" | "false"; /** @description A campus id or slug, or 'all' for church-wide events only */ campus?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; title: string; description: string | null; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; isActive: boolean; isHidden: boolean; requiresRegistration: boolean; /** @enum {string} */ scheduleType: "single" | "sessions"; /** @enum {string} */ attendanceMode: "whole" | "pick"; /** @enum {string} */ cashupStatus: "open" | "closed"; campusId: string | null; seriesId: string | null; picture: string | null; eventOptions?: ({ id: string; name: string; price: number; isMainTicket: boolean; stockLimit: number; } & { [key: string]: unknown; })[]; sessions?: ({ id: string; label: string | null; /** Format: date-time */ startsAt: string; /** Format: date-time */ endsAt: string; cancelled: boolean; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEvents: { parameters: { query?: { /** @description Page number, from 1 */ page?: number; /** @description Items per page (at most 100) */ limit?: number; /** @description Search the title */ q?: string; /** @description A campus id or slug (its events plus church-wide ones), or 'all' for church-wide events only */ campus?: string; /** @description A series slug */ series?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; title: string; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; location: string | null; /** @description The headline price in rand (0 = free) */ price: number; pictureUrl: string | null; requiresRegistration: boolean; /** @enum {string} */ scheduleType: "single" | "sessions"; /** @description null = for all campuses (or campuses are off) */ campus: { id: string; name: string; slug: string; } | null; series: { id: string; name: string; slug: string; } | null; }[]; meta: { page: number; limit: number; /** @description Items across all pages */ total: number; /** @description Number of pages (at least 1) */ pages: number; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEvents: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { title: string; description?: string | null; startDate: string; endDate: string; price?: number | string; campusId?: string | null; seriesId?: string | null; /** @enum {string} */ scheduleType?: "single" | "sessions"; sessions?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; title: string; description: string | null; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; isActive: boolean; isHidden: boolean; requiresRegistration: boolean; /** @enum {string} */ scheduleType: "single" | "sessions"; /** @enum {string} */ attendanceMode: "whole" | "pick"; /** @enum {string} */ cashupStatus: "open" | "closed"; campusId: string | null; seriesId: string | null; picture: string | null; eventOptions?: ({ id: string; name: string; price: number; isMainTicket: boolean; stockLimit: number; } & { [key: string]: unknown; })[]; sessions?: ({ id: string; label: string | null; /** Format: date-time */ startsAt: string; /** Format: date-time */ endsAt: string; cancelled: boolean; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; title: string; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; location: string | null; /** @description The headline price in rand (0 = free) */ price: number; pictureUrl: string | null; requiresRegistration: boolean; /** @enum {string} */ scheduleType: "single" | "sessions"; /** @description null = for all campuses (or campuses are off) */ campus: { id: string; name: string; slug: string; } | null; series: { id: string; name: string; slug: string; } | null; description: string | null; registrationDeadline: string | null; ticketOptions: { id: string; name: string; /** @description The normal price in rand */ price: number; /** @description What it costs now (an early-bird price while one runs) */ currentPrice: number; isMainTicket: boolean; /** * @description "pick" = the buyer chooses sessions * @enum {string} */ sessionMode: "all" | "pick"; }[]; /** @description Multi-day events only; empty otherwise */ sessions: { id: string; label: string | null; /** Format: date-time */ startsAt: string; /** Format: date-time */ endsAt: string; location: string | null; cancelled: boolean; }[]; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteEventsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @constant */ isActive: false; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchEventsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { title?: string; description?: string | null; startDate?: string; endDate?: string; price?: number | string; campusId?: string | null; seriesId?: string | null; /** @enum {string} */ scheduleType?: "single" | "sessions"; sessions?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; title: string; description: string | null; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; isActive: boolean; isHidden: boolean; requiresRegistration: boolean; /** @enum {string} */ scheduleType: "single" | "sessions"; /** @enum {string} */ attendanceMode: "whole" | "pick"; /** @enum {string} */ cashupStatus: "open" | "closed"; campusId: string | null; seriesId: string | null; picture: string | null; eventOptions?: ({ id: string; name: string; price: number; isMainTicket: boolean; stockLimit: number; } & { [key: string]: unknown; })[]; sessions?: ({ id: string; label: string | null; /** Format: date-time */ startsAt: string; /** Format: date-time */ endsAt: string; cancelled: boolean; } & { [key: string]: unknown; })[]; sessionChanges: { [key: string]: number; } | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdCopy-from": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { fromEventId: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description Allocation sets copied */ sets: number; /** @description Groups copied */ groups: number; /** @description Costs copied (admins) */ costs: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getEventsIdNotify-recipients": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; email: string; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; }[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "putEventsIdNotify-recipients": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { userIds: string[]; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; email: string; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; }[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdFull: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; title: string; description: string | null; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; isActive: boolean; isHidden: boolean; requiresRegistration: boolean; /** @enum {string} */ scheduleType: "single" | "sessions"; /** @enum {string} */ attendanceMode: "whole" | "pick"; /** @enum {string} */ cashupStatus: "open" | "closed"; campusId: string | null; seriesId: string | null; picture: string | null; eventOptions?: ({ id: string; name: string; price: number; isMainTicket: boolean; stockLimit: number; } & { [key: string]: unknown; })[]; sessions?: ({ id: string; label: string | null; /** Format: date-time */ startsAt: string; /** Format: date-time */ endsAt: string; cancelled: boolean; } & { [key: string]: unknown; })[]; form: ({ id: string; isRequired: boolean; fields: ({ id: string; type: string; label: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }) | null; attachments: ({ id: string; originalName: string; url: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getEventsIdCalendar.ics": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The file */ 200: { headers: { [name: string]: unknown; }; content: { "text/calendar": string; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getEventsBy-aliasAlias": { parameters: { query?: never; header?: never; path: { /** @description The short link, e.g. camp2026 */ alias: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; title: string; description: string | null; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; registrationDeadline: string | null; goLiveAt: string | null; price: number; picture: string | null; redirectUrl: string | null; /** @description Not over yet */ isLive: boolean; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdTicket-options": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name: string; price: number | string; isMainTicket?: boolean; /** @description 0 = no limit */ stockLimit?: number | string; /** @description What staff pay (empty = the normal price) */ staffPrice?: (number | string) | null; /** * @description "pick" = buyers choose sessions (multi-day events) * @enum {string} */ sessionMode?: "all" | "pick"; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; price: number; isMainTicket: boolean; stockLimit: number; staffPrice: number | null; /** @enum {string} */ sessionMode: "all" | "pick"; earlyBirdTiers?: ({ id: string; /** Format: date-time */ deadline: string; price: number; stockLimit: number; variantId: string | null; } & { [key: string]: unknown; })[]; variants?: ({ id: string; name: string; price: number | null; stockLimit: number; staffPrice: number | null; order: number; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteTicket-optionsId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @constant */ deleted: true; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "patchTicket-optionsId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string; price?: number | string; isMainTicket?: boolean; /** @description 0 = no limit */ stockLimit?: number | string; /** @description What staff pay (empty = the normal price) */ staffPrice?: (number | string) | null; /** * @description "pick" = buyers choose sessions (multi-day events) * @enum {string} */ sessionMode?: "all" | "pick"; earlyBirdTiers?: ({ id?: string; deadline: string; price: number | string; stockLimit?: number | string; variantId?: string | null; } & { [key: string]: unknown; })[]; variants?: { name: string; /** @description Empty = the option's price */ price?: (number | string) | null; stockLimit?: number | string; staffPrice?: (number | string) | null; order?: number | string; id?: string; }[]; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; price: number; isMainTicket: boolean; stockLimit: number; staffPrice: number | null; /** @enum {string} */ sessionMode: "all" | "pick"; earlyBirdTiers?: ({ id: string; /** Format: date-time */ deadline: string; price: number; stockLimit: number; variantId: string | null; } & { [key: string]: unknown; })[]; variants?: ({ id: string; name: string; price: number | null; stockLimit: number; staffPrice: number | null; order: number; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postTicket-optionsIdVariants": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name: string; /** @description Empty = the option's price */ price?: (number | string) | null; stockLimit?: number | string; staffPrice?: (number | string) | null; order?: number | string; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; price: number | null; stockLimit: number; staffPrice: number | null; order: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteVariantsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @constant */ deleted: true; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchVariantsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string; /** @description Empty = the option's price */ price?: (number | string) | null; stockLimit?: number | string; staffPrice?: (number | string) | null; order?: number | string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; price: number | null; stockLimit: number; staffPrice: number | null; order: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdAttachments: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; originalName: string; filename: string; mimeType: string; size: number; url: string | null; /** Format: date-time */ createdAt: string; }[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdAttachments: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "multipart/form-data": { /** * Format: binary * @description PDF, Word, Excel, PowerPoint, text, CSV or ZIP, up to 20 MB */ file: string; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; originalName: string; filename: string; mimeType: string; size: number; url: string | null; /** Format: date-time */ createdAt: string; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteEventsIdAttachmentsAttachmentId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; /** @description The attachment's id */ attachmentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @constant */ deleted: true; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getAttachmentsStatus: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { databaseTableQueryable: boolean; probeError: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAttachmentsSync: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @default false */ dryRun?: boolean; /** @default false */ remove?: boolean; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { dryRun: boolean; remove: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getSections: { parameters: { query?: { /** @description Only this event */ eventId?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; eventId: string; name: string; allowedOptions: ({ eventOptionId: string; eventOption: { id: string; name: string; } & { [key: string]: unknown; }; } & { [key: string]: unknown; })[]; event: { id: string; title: string; }; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postSections: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; name: string; allowedOptionIds?: string[]; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; allowedOptions: ({ eventOptionId: string; eventOption: { id: string; name: string; } & { [key: string]: unknown; }; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteSectionsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @constant */ deleted: true; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchSectionsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string; allowedOptionIds?: string[]; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; allowedOptions: ({ eventOptionId: string; eventOption: { id: string; name: string; } & { [key: string]: unknown; }; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdCosts: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; label: string; /** @enum {string} */ costType: "once_off" | "per_item"; amount: number; eventOptionId: string | null; eventOption: { id: string; name: string; } | null; /** @description How it was paid out of the takings (cash, card, eft, other) */ paidFromMethod: string | null; notes: string | null; /** Format: date-time */ createdAt: string; /** Format: date-time */ updatedAt?: string; }[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdCosts: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { label: string; /** * @description per_item = per ticket sold of `eventOptionId` * @enum {string} */ costType: "once_off" | "per_item"; amount: number | string; eventOptionId?: string | null; notes?: string | null; paidFromMethod?: ("cash" | "card" | "eft" | "other") | null; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; label: string; /** @enum {string} */ costType: "once_off" | "per_item"; amount: number; eventOptionId: string | null; eventOption: { id: string; name: string; } | null; /** @description How it was paid out of the takings (cash, card, eft, other) */ paidFromMethod: string | null; notes: string | null; /** Format: date-time */ createdAt: string; /** Format: date-time */ updatedAt?: string; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteCostsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @constant */ deleted: true; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchCostsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { label?: string; /** * @description per_item = per ticket sold of `eventOptionId` * @enum {string} */ costType?: "once_off" | "per_item"; amount?: number | string; eventOptionId?: string | null; notes?: string | null; paidFromMethod?: ("cash" | "card" | "eft" | "other") | null; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; label: string; /** @enum {string} */ costType: "once_off" | "per_item"; amount: number; eventOptionId: string | null; eventOption: { id: string; name: string; } | null; /** @description How it was paid out of the takings (cash, card, eft, other) */ paidFromMethod: string | null; notes: string | null; /** Format: date-time */ createdAt: string; /** Format: date-time */ updatedAt?: string; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postUploadsEvent-image": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "multipart/form-data": { /** * Format: binary * @description A JPEG, PNG, GIF or WebP image */ image: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description What to save on the event or setting */ path: string; /** @description The same, as a full address */ url: string; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postUploadsLogo: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "multipart/form-data": { /** * Format: binary * @description A JPEG, PNG, WebP or SVG image */ image: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description What to save on the event or setting */ path: string; /** @description The same, as a full address */ url: string; }; }; }; }; }; }; postUploadsFavicon: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "multipart/form-data": { /** * Format: binary * @description An ICO, PNG or SVG image */ image: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description What to save on the event or setting */ path: string; /** @description The same, as a full address */ url: string; }; }; }; }; }; }; getSeries: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; name: string; slug: string; description: string | null; picture: string | null; followers: number; eventCount: number; events: ({ id: string; title: string; /** Format: date-time */ startDate: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postSeries: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name: string; /** @description The web address part (/series/); made from the name when left out */ slug?: string; description?: string | null; picture?: string | null; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; slug: string; description: string | null; picture: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteSeriesId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @constant */ deleted: true; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchSeriesId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string; /** @description The web address part (/series/); made from the name when left out */ slug?: string; description?: string | null; picture?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; slug: string; description: string | null; picture: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getSeriesBy-slugSlug": { parameters: { query?: never; header?: never; path: { /** @description The short name in the address */ slug: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; slug: string; description: string | null; picture: string | null; upcoming: ({ id: string; } & { [key: string]: unknown; })[]; past: ({ id: string; } & { [key: string]: unknown; })[]; following: boolean; passes: ({ id: string; name: string; price: number; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getSeriesIdCompare: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { series: { [key: string]: unknown; }; events: ({ eventId: string; title: string; /** @description Date and time (ISO 8601) */ startDate: string; /** @description Date and time (ISO 8601) */ endDate: string; campus?: { [key: string]: unknown; } | null; isActive: boolean; sessions?: number | null; registrations: number; tickets: number; /** @description Rand */ income: number; checkedIn: number; /** @description % */ attendanceRate?: number | null; change: ({ /** @description % change from the year before */ registrations?: number | null; /** @description % change from the year before */ tickets?: number | null; /** @description % change from the year before */ income?: number | null; /** @description % change from the year before */ checkedIn?: number | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putSeriesIdFollow: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { following: boolean; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteSeriesIdFollow: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { following: boolean; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getSeason-passes": { parameters: { query?: { /** @description Only this event series */ seriesId?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; seriesId: string; name: string; price: number; isActive: boolean; items: ({ eventId: string; } & { [key: string]: unknown; })[]; sold: number; unpaid: number; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postSeason-passes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { seriesId: string; name: string; description?: string | null; price: number | string; saleEndsAt?: string | null; isActive?: boolean; items: { eventId: string; eventOptionId: string; variantId?: string | null; }[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; seriesId: string; name: string; price: number; isActive: boolean; items: ({ eventId: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteSeason-passesId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @constant */ deleted: true; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "patchSeason-passesId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { seriesId?: string; name?: string; description?: string | null; price?: number | string; saleEndsAt?: string | null; isActive?: boolean; items?: { eventId: string; eventOptionId: string; variantId?: string | null; }[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; seriesId: string; name: string; price: number; isActive: boolean; items: ({ eventId: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postSeason-passesIdBuy": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @default 1 */ quantity?: number; provider?: string; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { purchaseId: string; /** @description Rand */ total: number; /** @description Free: the tickets are issued straight away */ paid: boolean; /** @description Where to send them to pay */ redirectUrl?: string | null; provider?: string | null; message?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postSeason-pass-purchasesIdCheckout": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { provider?: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { redirectUrl?: string | null; provider?: string | null; message?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getMeSeason-passes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; quantity: number; total: number; status: string; /** Format: date-time */ createdAt: string; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdBundles: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; eventId: string; name: string; /** @enum {string} */ kind: "exact" | "mix" | "free" | "group"; price: number | null; isActive: boolean; summary: string; headline: string; available: boolean; uses: number; registrations: number; totalDiscount: number; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdBundles: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name: string; /** * @description exact = this set; mix = any N; free = buy N get M free; group = a price for groups * @enum {string} */ kind?: "exact" | "mix" | "free" | "group"; price?: (number | string) | null; setSize?: number | null; freeCount?: number | null; groupPricing?: ("per_ticket" | "percent") | null; items?: { eventOptionId: string; variantId?: string | null; quantity?: number; }[]; description?: string | null; isActive?: boolean; validFrom?: string | null; validUntil?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; /** @enum {string} */ kind: "exact" | "mix" | "free" | "group"; price: number | null; isActive: boolean; summary: string; headline: string; available: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteBundlesId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ deleted?: true; /** @constant */ switchedOff?: true; message: string; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchBundlesId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string; /** * @description exact = this set; mix = any N; free = buy N get M free; group = a price for groups * @enum {string} */ kind?: "exact" | "mix" | "free" | "group"; price?: (number | string) | null; setSize?: number | null; freeCount?: number | null; groupPricing?: ("per_ticket" | "percent") | null; items?: { eventOptionId: string; variantId?: string | null; quantity?: number; }[]; description?: string | null; isActive?: boolean; validFrom?: string | null; validUntil?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; /** @enum {string} */ kind: "exact" | "mix" | "free" | "group"; price: number | null; isActive: boolean; summary: string; headline: string; available: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postBundlesQuote: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; options: { eventOptionId: string; variantId?: string | null; quantity: number; sessionIds?: string[]; }[]; /** @description Staff: price it for this person (null = a walk-in without an account) */ forUserId?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { subtotal: number; bundleDiscount: number; bundles: { [key: string]: unknown; }[]; total: number; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCoupons: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; code: string; /** @enum {string} */ type: "percent" | "fixed" | "comp"; value: number; active: boolean; summary: string; uses: number; totalDiscount: number; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postCoupons: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { code: string; /** * @description comp = free * @enum {string} */ type: "percent" | "fixed" | "comp"; value?: number | string; description?: string | null; active?: boolean; stackEarlyBird?: boolean; validFrom?: string | null; validUntil?: string | null; maxUses?: (number | string) | null; maxUsesPerUser?: (number | string) | null; minQuantity?: (number | string) | null; restrictRoles?: ("user" | "staff" | "supervisor" | "admin")[]; restrictDomain?: string | null; /** @description Empty = every event (not for campus-scoped supervisors) */ eventIds?: string[]; options?: { eventOptionId: string; variantId?: string | null; }[]; userIds?: string[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; code: string; /** @enum {string} */ type: "percent" | "fixed" | "comp"; value: number; active: boolean; summary: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCouponsRedemptions: { parameters: { query?: { /** @description Comma-separated */ eventIds?: string; /** @description On or after (ISO date or date-time) */ from?: string; /** @description On or before (ISO date or date-time) */ to?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @enum {string} */ kind: "coupon" | "bundle"; uses: number; discountAmount: number; /** Format: date-time */ createdAt: string; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCouponsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; code: string; /** @enum {string} */ type: "percent" | "fixed" | "comp"; value: number; active: boolean; summary: string; redemptions: ({ id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchCouponsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { code?: string; /** * @description comp = free * @enum {string} */ type?: "percent" | "fixed" | "comp"; value?: number | string; description?: string | null; active?: boolean; stackEarlyBird?: boolean; validFrom?: string | null; validUntil?: string | null; maxUses?: (number | string) | null; maxUsesPerUser?: (number | string) | null; minQuantity?: (number | string) | null; restrictRoles?: ("user" | "staff" | "supervisor" | "admin")[]; restrictDomain?: string | null; /** @description Empty = every event (not for campus-scoped supervisors) */ eventIds?: string[]; options?: { eventOptionId: string; variantId?: string | null; }[]; userIds?: string[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; code: string; /** @enum {string} */ type: "percent" | "fixed" | "comp"; value: number; active: boolean; summary: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postCouponsCheck: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; options: { eventOptionId: string; variantId?: string | null; quantity: number; sessionIds?: string[]; }[]; /** @description Staff: price it for this person (null = a walk-in without an account) */ forUserId?: string | null; code: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ valid: true; code: string; type: string; value: number; summary: string; description: string | null; discount: number; bundleDiscount: number; bundles: { [key: string]: unknown; }[]; subtotal: number; total: number; } | { /** @constant */ valid: false; message: string; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCampuses: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { enabled: boolean; campuses: ({ id: string; name: string; slug: string; } & { [key: string]: unknown; })[]; }; }; }; }; }; }; postCampuses: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name: string; slug?: string; colour?: string | null; /** @description Who gets this campus's daily summary (staff only) */ notifyRecipientIds?: string[]; archived?: boolean; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; slug: string; archivedAt: string | null; order: number; _count: { events: number; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCampusesAdmin: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { enabled: boolean; campuses: ({ id: string; name: string; slug: string; archivedAt: string | null; order: number; _count: { events: number; } & { [key: string]: unknown; }; } & { [key: string]: unknown; })[]; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getCampusesBy-slugSlug": { parameters: { query?: never; header?: never; path: { /** @description The short name in the address */ slug: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; slug: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putCampusesEnabled: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { enabled: boolean; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { enabled: boolean; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putCampusesOrder: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { ids: string[]; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { ids: string[]; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteCampusesId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @constant */ deleted: true; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchCampusesId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string; slug?: string; colour?: string | null; /** @description Who gets this campus's daily summary (staff only) */ notifyRecipientIds?: string[]; archived?: boolean; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; slug: string; archivedAt: string | null; order: number; _count: { events: number; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCampusesIdAudience: { parameters: { query?: { /** @description `true`: also people registered for its events in the last 12 months */ registrants?: "true" | "false"; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { campus: { id: string; name: string; }; users: { id: string; name: string; email: string; phoneNumber: string | null; }[]; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getRegistrations: { parameters: { query?: { /** @description Page number, from 1 */ page?: number; /** @description At most 200 */ limit?: number; /** @description `true`: only ones with money still owed */ unpaid?: "true" | "false"; /** @description Only this person */ userId?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; eventId: string; userId: string; totalDueComputed?: number; } & { [key: string]: unknown; })[]; meta: { page: number; limit: number; total: number; pages: number; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postRegistrations: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; options: { eventOptionId: string; quantity: number; variantId?: string | null; /** @description "Pick sessions" tickets: the sessions chosen */ sessionIds?: string[]; }[]; guest?: { name: string; /** Format: email */ email: string; phone?: string; }; couponCode?: string; /** @description Names for the places (events that collect them) */ attendees?: { eventOptionId: string; variantId?: string | null; name: string; email?: string | null; phone?: string | null; /** @description YYYY-MM-DD (youth events) */ dateOfBirth?: string | null; gender?: string | null; parentName?: string | null; parentEmail?: string | null; parentPhone?: string | null; }[]; /** * @description With attendees: tickets to the payer, or to each attendee * @enum {string} */ ticketDelivery?: "payer" | "each"; waitlistToken?: string; analyticsSessionId?: string; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; /** Format: date-time */ createdAt: string; event: { id: string; title: string; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; }; items: { ticket: string; variant: string | null; quantity: number; unitPrice: number; }[]; /** @description In rand, after discounts */ totalDue: number; /** @description In rand (refunds subtracted) */ amountPaid: number; /** @description totalDue − amountPaid; 0 or less = nothing owing */ balance: number; /** @description false = added to an existing registration */ isNew: boolean; couponError: string | null; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getRegistrationsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; /** Format: date-time */ createdAt: string; event: { id: string; title: string; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; }; items: { ticket: string; variant: string | null; quantity: number; unitPrice: number; }[]; /** @description In rand, after discounts */ totalDue: number; /** @description In rand (refunds subtracted) */ amountPaid: number; /** @description totalDue − amountPaid; 0 or less = nothing owing */ balance: number; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postRegistrationsIdCancel: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; /** Format: date-time */ createdAt: string; event: { id: string; title: string; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; }; items: { ticket: string; variant: string | null; quantity: number; unitPrice: number; }[]; /** @description In rand, after discounts */ totalDue: number; /** @description In rand (refunds subtracted) */ amountPaid: number; /** @description totalDue − amountPaid; 0 or less = nothing owing */ balance: number; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postRegistrationsIdCheckout: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description An optional donation added on top, in rand */ donationAmount?: number; /** @description yoco or payfast (default: the first one switched on) */ provider?: string; /** Format: uri */ successUrl?: string; /** Format: uri */ cancelUrl?: string; /** Format: uri */ failureUrl?: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ priceUpdated: true; newBalance: number; message: string; } | { /** @constant */ priceUpdated: false; checkoutId: string; redirectUrl: string; provider: string; /** @description Charged now, in rand (with any donation) */ amount: number; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMe: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; email: string; phone: string | null; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; twoFactorEnabled: boolean; /** @enum {string} */ notificationPreference: "email" | "whatsapp" | "both"; homeCampusId: string | null; /** Format: date-time */ createdAt: string; /** @description Their role must use two-step sign-in */ twoFactorRequired: boolean; newsPromptPending: boolean; noticePromptPending: false | ("first" | "updated"); campusScope: string[] | null; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchMe: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name?: string; /** Format: email */ email?: string; /** @description null or empty removes it */ phone?: string | null; /** @enum {string} */ notificationPreference?: "email" | "whatsapp" | "both"; /** @description While campuses are on */ homeCampusId?: string | null; password?: string; currentPassword?: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; email: string; phone: string | null; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; twoFactorEnabled: boolean; /** @enum {string} */ notificationPreference: "email" | "whatsapp" | "both"; homeCampusId: string | null; /** Format: date-time */ createdAt: string; }; token: string; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMeRegistrations: { parameters: { query?: { /** @description Page number, from 1 */ page?: number; /** @description Items per page (at most 100) */ limit?: number; /** @description Include past and cancelled registrations */ past?: "true" | "false"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; /** Format: date-time */ createdAt: string; event: { id: string; title: string; /** Format: date-time */ startDate: string; /** Format: date-time */ endDate: string; }; items: { ticket: string; variant: string | null; quantity: number; unitPrice: number; }[]; /** @description In rand, after discounts */ totalDue: number; /** @description In rand (refunds subtracted) */ amountPaid: number; /** @description totalDue − amountPaid; 0 or less = nothing owing */ balance: number; }[]; meta: { page: number; limit: number; /** @description Items across all pages */ total: number; /** @description Number of pages (at least 1) */ pages: number; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getRegistrationsIdFull: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; eventId: string; userId: string; totalDueComputed?: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMeRegistrationsFull: { parameters: { query?: { /** @description `true`: include ones that are over too */ past?: "true" | "false"; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; eventId: string; userId: string; totalDueComputed?: number; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putRegistrationsIdItems: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { options: { eventOptionId: string; variantId?: string | null; quantity: number; }[]; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; eventId: string; userId: string; totalDueComputed?: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postRegistrationsIdInvoice: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @default email * @enum {string} */ channel?: "email" | "whatsapp"; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postRegistrationsIdCoupon: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { code: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; eventId: string; userId: string; totalDueComputed?: number; message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteRegistrationsIdCoupon: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putRegistrationsIdAttendees: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { attendees: ({ /** @description An attendee already on it (left out = removed) */ id?: string; eventOptionId: string; variantId?: string | null; name: string; } & { [key: string]: unknown; })[]; /** @enum {string} */ ticketDelivery?: "payer" | "each"; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; ticketDelivery: string | null; attendees: ({ id: string; name: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postRegistrationsIdAttendeesAttendeeIdForm-link": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; /** @description The named attendee's id */ attendeeId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getRegistrationsIdForm-draft": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { data: { [key: string]: unknown; }; updatedAt: string | null; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "putRegistrationsIdForm-draft": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { data: { [key: string]: unknown; }; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; updatedAt: string; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "putRegistrationsIdForm-responses": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { responses: { /** @description The named attendee this form is for */ attendeeId?: string | null; /** @description Field id → answer (stored as text) */ answers: { [key: string]: unknown; }; }[]; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postRegistrationsIdForm-responses": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { responses: { /** @description The named attendee this form is for */ attendeeId?: string | null; /** @description Field id → answer (stored as text) */ answers: { [key: string]: unknown; }; }[]; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; count?: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdRegistrations: { parameters: { query?: { /** @description Text to search for */ search?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; eventId: string; userId: string; totalDueComputed?: number; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchRegistrationsIdStatus: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; eventId: string; userId: string; totalDueComputed?: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postRegistrationsManual: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; options: { eventOptionId: string; variantId?: string | null; quantity: number; sessionIds?: string[]; }[]; user: { name: string; email?: string | null; phoneNumber?: string | null; /** @description Self-service kiosk: the visitor sets it, and the account is active at once */ password?: string; } & { [key: string]: unknown; }; /** @description email, whatsapp or both (anything else: worked out from the contact details given) */ notificationPreference?: string | null; skipActivationNotice?: boolean; couponCode?: string | null; attendees?: ({ /** @description An attendee already on it (left out = removed) */ id?: string; eventOptionId: string; variantId?: string | null; name: string; } & { [key: string]: unknown; })[]; /** @enum {string} */ ticketDelivery?: "payer" | "each"; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; eventId: string; userId: string; totalDueComputed?: number; couponError?: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postRegistrationsBulk: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @enum {string} */ action: "markPaid" | "cancel" | "moveOption" | "allocate" | "message"; registrationIds: string[]; /** @description markPaid: cash, eft, card or other */ method?: string | null; /** @description markPaid */ paidAt?: string | null; /** @description moveOption */ fromOptionId?: string | null; /** @description moveOption */ toOptionId?: string | null; /** @description allocate */ setId?: string | null; /** @description allocate */ groupId?: string | null; /** * @description message * @enum {string} */ channel?: "email" | "whatsapp"; /** @description message (email) */ subject?: string | null; /** @description message */ text?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { action: string; done: number; skipped: number; failed: number; results: ({ id: string; ok: boolean; skipped?: boolean | null; message?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPaymentsProviders: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { providers: ({ /** @description yoco, payfast */ id: string; label: string; } & { [key: string]: unknown; })[]; /** @description Smallest online payment */ minimumAmount: number; } & { [key: string]: unknown; }; }; }; }; }; }; getPaymentsProvidersSettings: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { providers: ({ id: string; label: string; enabled: boolean; /** @description Its keys are set up */ configured: boolean; /** @description What the provider can do, e.g. look payments up */ capabilities: { [key: string]: unknown; }; } & { [key: string]: unknown; })[]; /** @description Rand */ minimumAmount: number; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putPaymentsProvidersSettings: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Every provider, in the order to offer them */ providers: ({ id: string; enabled: boolean; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; providers: ({ id: string; label: string; enabled: boolean; /** @description Its keys are set up */ configured: boolean; /** @description What the provider can do, e.g. look payments up */ capabilities: { [key: string]: unknown; }; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getPaymentsOpen-checkouts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { checkouts: ({ id: string; provider: string; providerLabel: string; /** @description The provider can be asked whether it was paid */ canCheck: boolean; /** @description Rand */ amount: number; description: string; /** @description registration, donation, sponsorship, season_pass… */ type?: string | null; registrationId?: string | null; payer?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; /** @description How far back it looks */ days: number; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postPaymentsOpen-checkoutsCheck": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Checkouts to ask about (default: every open one), at most 200 */ ids?: string[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { results: { [key: string]: unknown; }[]; /** @description Payments found and recorded */ recorded: number; message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPaymentsStats: { parameters: { query?: { /** @description Page number, from 1 */ page?: string; /** @description How many per page */ limit?: string; /** @description Only this person */ userId?: string; /** @description On or after (ISO date or date-time) */ from?: string; /** @description `1`: only donations and the parts put towards registrations */ donations?: string; /** @description Payment method: cash, card, eft, other */ method?: string; /** @description payment or refund */ kind?: string; /** @description On or after (ISO date) */ startDate?: string; /** @description On or before (ISO date) */ endDate?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description Rand */ totalToday: number; /** @description Rand */ totalWeek: number; /** @description Rand */ totalMonth: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPayments: { parameters: { query?: { /** @description Page number, from 1 */ page?: string; /** @description How many per page */ limit?: string; /** @description Only this person */ userId?: string; /** @description On or after (ISO date or date-time) */ from?: string; /** @description `1`: only donations and the parts put towards registrations */ donations?: string; /** @description Payment method: cash, card, eft, other */ method?: string; /** @description payment or refund */ kind?: string; /** @description On or after (ISO date) */ startDate?: string; /** @description On or before (ISO date) */ endDate?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { data: ({ id: string; /** @description Rand; a refund is negative */ amount: number; /** @description cash, card, eft, other — or the wallet type for an online payment */ method: string; /** @description yoco or payfast for an online payment */ provider?: string | null; userId: string; recordedById?: string | null; registrationId?: string | null; eventId?: string | null; isDonation: boolean; isSponsorship?: boolean | null; /** @description A refund: the payment it refunds; a donation leg: the donation */ originalPaymentId?: string | null; externalId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; recordedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; registration?: ({ id: string; userId: string; eventId: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; total: number; page: number; limit: number; pages: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPayments: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { registrationId?: string | null; /** @description A donation: the event */ eventId?: string | null; amount: number | string; /** @description cash, card, eft or other */ method: string; isDonation?: boolean | null; /** @description Backdate it */ paidAt?: string | null; /** @description A donation: who gave it */ userId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description Rand; a refund is negative */ amount: number; /** @description cash, card, eft, other — or the wallet type for an online payment */ method: string; /** @description yoco or payfast for an online payment */ provider?: string | null; userId: string; recordedById?: string | null; registrationId?: string | null; eventId?: string | null; isDonation: boolean; isSponsorship?: boolean | null; /** @description A refund: the payment it refunds; a donation leg: the donation */ originalPaymentId?: string | null; externalId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; recordedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; registration?: ({ id: string; userId: string; eventId: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; /** @description Tickets issued because this paid it in full */ generatedTickets?: ({ id: string; /** @description What the QR code holds */ qrCode: string; /** @description People on the ticket */ quantity: number; isUsed: boolean; eventId: string; /** @description The payer */ userId: string; registrationOptionId: string; /** @description A named ticket: the person it's for */ attendeeId?: string | null; holderUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; /** @description Attendee forms still holding the tickets back (1.52.0) */ formsNeeded?: number | null; /** @description What was paid over the balance, kept as a donation */ donationSplit?: { id: string; /** @description Rand; a refund is negative */ amount: number; /** @description cash, card, eft, other — or the wallet type for an online payment */ method: string; /** @description yoco or payfast for an online payment */ provider?: string | null; userId: string; recordedById?: string | null; registrationId?: string | null; eventId?: string | null; isDonation: boolean; isSponsorship?: boolean | null; /** @description A refund: the payment it refunds; a donation leg: the donation */ originalPaymentId?: string | null; externalId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; recordedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPaymentsRefunds: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The payment refunded (or registrationId) */ paymentId?: string | null; registrationId?: string | null; userId: string; /** @description Positive; stored as a negative payment */ amount: number | string; method: string; reason?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description Rand; a refund is negative */ amount: number; /** @description cash, card, eft, other — or the wallet type for an online payment */ method: string; /** @description yoco or payfast for an online payment */ provider?: string | null; userId: string; recordedById?: string | null; registrationId?: string | null; eventId?: string | null; isDonation: boolean; isSponsorship?: boolean | null; /** @description A refund: the payment it refunds; a donation leg: the donation */ originalPaymentId?: string | null; externalId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; recordedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPaymentsDonationsAssign: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The donation */ paymentId: string; registrationId: string; /** @description Default: as much as both allow */ amount?: number | string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message?: string | null; updatedRegistration?: { id: string; userId: string; eventId: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; generatedTickets?: ({ id: string; /** @description What the QR code holds */ qrCode: string; /** @description People on the ticket */ quantity: number; isUsed: boolean; eventId: string; /** @description The payer */ userId: string; registrationOptionId: string; /** @description A named ticket: the person it's for */ attendeeId?: string | null; holderUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPaymentsDonationsUnassign: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { legId: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; updatedRegistration: { id: string; userId: string; eventId: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; donationId: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postDonationsCheckout: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; amount: number | string; provider?: string | null; successUrl?: string | null; cancelUrl?: string | null; failureUrl?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { checkoutId?: string | null; /** @description Where to send the person to pay (null when the provider takes a form) */ redirectUrl?: string | null; provider?: string | null; /** @description A form to post (PayFast) */ form?: ({ action: string; fields: { [key: string]: string; }; } & { [key: string]: unknown; }) | null; /** @description Rand */ amount: number; event: { id?: string; title?: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMePayments: { parameters: { query?: { /** @description Page number, from 1 */ page?: string; /** @description How many per page */ limit?: string; /** @description Only this person */ userId?: string; /** @description On or after (ISO date or date-time) */ from?: string; /** @description `1`: only donations and the parts put towards registrations */ donations?: string; /** @description Payment method: cash, card, eft, other */ method?: string; /** @description payment or refund */ kind?: string; /** @description On or after (ISO date) */ startDate?: string; /** @description On or before (ISO date) */ endDate?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { data: ({ id: string; /** @description Rand; a refund is negative */ amount: number; /** @description cash, card, eft, other — or the wallet type for an online payment */ method: string; /** @description yoco or payfast for an online payment */ provider?: string | null; userId: string; recordedById?: string | null; registrationId?: string | null; eventId?: string | null; isDonation: boolean; isSponsorship?: boolean | null; /** @description A refund: the payment it refunds; a donation leg: the donation */ originalPaymentId?: string | null; externalId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; recordedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; registration?: ({ id: string; userId: string; eventId: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; total: number; page: number; limit: number; pages: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPaymentsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description Rand; a refund is negative */ amount: number; /** @description cash, card, eft, other — or the wallet type for an online payment */ method: string; /** @description yoco or payfast for an online payment */ provider?: string | null; userId: string; recordedById?: string | null; registrationId?: string | null; eventId?: string | null; isDonation: boolean; isSponsorship?: boolean | null; /** @description A refund: the payment it refunds; a donation leg: the donation */ originalPaymentId?: string | null; externalId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; recordedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; registration?: ({ id: string; userId: string; eventId: string; /** @enum {string} */ status: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPaymentsIdReceipt: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { channel?: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getRegistrationsIdPayments: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description Rand; a refund is negative */ amount: number; /** @description cash, card, eft, other — or the wallet type for an online payment */ method: string; /** @description yoco or payfast for an online payment */ provider?: string | null; userId: string; recordedById?: string | null; registrationId?: string | null; eventId?: string | null; isDonation: boolean; isSponsorship?: boolean | null; /** @description A refund: the payment it refunds; a donation leg: the donation */ originalPaymentId?: string | null; externalId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; recordedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postRegistrationsIdPayment-link": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { amount?: number | string; donationAmount?: number | string; provider?: string | null; successUrl?: string | null; cancelUrl?: string | null; failureUrl?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { checkoutId?: string | null; /** @description Where to send the person to pay (null when the provider takes a form) */ redirectUrl?: string | null; provider?: string | null; /** @description A form to post (PayFast) */ form?: ({ action: string; fields: { [key: string]: string; }; } & { [key: string]: unknown; }) | null; priceUpdated?: boolean | null; newTotal?: number | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postRegistrationsIdPayment-linkSend": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The link to send */ redirectUrl: string; /** @enum {string} */ channel: "email" | "whatsapp"; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ sent: true; channel: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdPayments: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description Rand; a refund is negative */ amount: number; /** @description cash, card, eft, other — or the wallet type for an online payment */ method: string; /** @description yoco or payfast for an online payment */ provider?: string | null; userId: string; recordedById?: string | null; registrationId?: string | null; eventId?: string | null; isDonation: boolean; isSponsorship?: boolean | null; /** @description A refund: the payment it refunds; a donation leg: the donation */ originalPaymentId?: string | null; externalId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; recordedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getPayment-linksId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @enum {string} */ status: "open" | "paid"; /** @description Rand */ amount: number; description: string; /** @description The provider already chosen, if any */ provider?: string | null; providers: ({ /** @description yoco, payfast */ id: string; label: string; } & { [key: string]: unknown; })[]; cancelUrl?: string | null; redirectUrl?: string | null; /** @description A signed form to post (PayFast) */ form?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postPayment-linksId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { provider?: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { provider: string; redirectUrl?: string | null; form?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCashupsAudit: { parameters: { query?: { /** @description Only this event */ eventId?: string; /** @description On or after (ISO date or date-time) */ from?: string; /** @description On or before (ISO date or date-time) */ to?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; eventId: string; /** @description close, quick_close, reopen */ action?: string | null; notes?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; performedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdCashup: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { [key: string]: unknown; }; /** @description Income per method */ paymentsByMethod: { [key: string]: unknown; }; /** @description Rand */ totalRevenue: number; costs: { [key: string]: unknown; }[]; /** @description Rand */ totalCosts: number; expectedCashByMethod: { [key: string]: unknown; }; /** @description The last close, line by line */ reconciled?: { [key: string]: unknown; } | null; /** @description Rand */ netProfit: number; /** @description Rand */ totalDonations: number; /** @description Rand */ unallocatedDonationsTotal: number; discountsTotal?: number | null; salesByOption?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getEventsIdCashupCash-by-user": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description Per person: who, cash recorded, cash counted */ rows: { [key: string]: unknown; }[]; cashActualTotal?: number | null; cashDenominations?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "putEventsIdCashupPerson-cashUserId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; /** @description The person's id */ userId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { denominations: ({ /** @description The note or coin, in rand */ value: number; count: number; } & { [key: string]: unknown; })[]; notes?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The saved count */ data: { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putEventsIdCashupDraft: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { lines: ({ /** @description cash, card, eft… */ method: string; bankAmount?: number | null; /** @description Cash only */ onHandAmount?: number | null; /** @description Not cash */ pendingAmount?: number | null; pendingReference?: string | null; writeOffs?: ({ category: string; amount?: number | null; reason?: string | null; } & { [key: string]: unknown; })[]; notes?: string | null; } & { [key: string]: unknown; })[]; notes?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdCashupClose: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Per payment method: in the bank, on hand, pending, write-offs (leave out for a quick close) */ lines?: ({ /** @description cash, card, eft… */ method: string; bankAmount?: number | null; /** @description Cash only */ onHandAmount?: number | null; /** @description Not cash */ pendingAmount?: number | null; pendingReference?: string | null; writeOffs?: ({ category: string; amount?: number | null; reason?: string | null; } & { [key: string]: unknown; })[]; notes?: string | null; } & { [key: string]: unknown; })[]; notes?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; /** @description close, quick_close, reopen */ action?: string | null; notes?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; performedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdCashupReopen: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Why */ notes?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; /** @description close, quick_close, reopen */ action?: string | null; notes?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; performedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postCashup-linesIdPending": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @enum {string} */ outcome: "received" | "written_off"; amount: number | string; /** @description A write-off: what it was for */ category?: string | null; notes?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The settlement recorded */ data: { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getProvider-transactions": { parameters: { query?: { /** @description yoco or payfast */ provider?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { success: boolean; data: ({ id: string; provider: string; providerLabel: string; /** @description The provider's id */ externalId: string; /** @description Cents */ amount?: number | null; currency?: string | null; createdDate?: string | null; checkoutId?: string | null; methodType?: string | null; reconciled: boolean; ignored: boolean; paymentId?: string | null; /** @description Why it needs a look */ note?: string | null; metadata?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; })[]; message?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getProvider-transactionsUnreconciled": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { success: boolean; data: ({ id: string; provider: string; providerLabel: string; /** @description The provider's id */ externalId: string; /** @description Cents */ amount?: number | null; currency?: string | null; createdDate?: string | null; checkoutId?: string | null; methodType?: string | null; reconciled: boolean; ignored: boolean; paymentId?: string | null; /** @description Why it needs a look */ note?: string | null; metadata?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; })[]; message?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postProvider-transactionsIdReconcile": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { registrationId?: string | null; /** @description As a donation to this event instead */ eventId?: string | null; userId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { success: boolean; data: { transaction: { id: string; provider: string; providerLabel: string; /** @description The provider's id */ externalId: string; /** @description Cents */ amount?: number | null; currency?: string | null; createdDate?: string | null; checkoutId?: string | null; methodType?: string | null; reconciled: boolean; ignored: boolean; paymentId?: string | null; /** @description Why it needs a look */ note?: string | null; metadata?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; }; payment: { id: string; /** @description Rand; a refund is negative */ amount: number; /** @description cash, card, eft, other — or the wallet type for an online payment */ method: string; /** @description yoco or payfast for an online payment */ provider?: string | null; userId: string; recordedById?: string | null; registrationId?: string | null; eventId?: string | null; isDonation: boolean; isSponsorship?: boolean | null; /** @description A refund: the payment it refunds; a donation leg: the donation */ originalPaymentId?: string | null; externalId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; recordedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; generatedTickets?: ({ id: string; /** @description What the QR code holds */ qrCode: string; /** @description People on the ticket */ quantity: number; isUsed: boolean; eventId: string; /** @description The payer */ userId: string; registrationOptionId: string; /** @description A named ticket: the person it's for */ attendeeId?: string | null; holderUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; message?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postProvider-transactionsIdIgnore": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { success: boolean; data: { id: string; provider: string; providerLabel: string; /** @description The provider's id */ externalId: string; /** @description Cents */ amount?: number | null; currency?: string | null; createdDate?: string | null; checkoutId?: string | null; methodType?: string | null; reconciled: boolean; ignored: boolean; paymentId?: string | null; /** @description Why it needs a look */ note?: string | null; metadata?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; }; message?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postWaitlist: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; eventOptionId: string; variantId?: string | null; /** @description Per-session tickets: the session */ sessionId?: string | null; quantity: number | string; /** @description Not signed in */ guestName?: string | null; guestEmail?: string | null; guestPhone?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; eventOptionId: string; variantId?: string | null; sessionId?: string | null; userId: string; quantity: number; /** @description Place in the queue */ position: number; /** @description waiting, offered, claimed, expired, removed, left */ status: string; offeredQuantity?: number | null; offeredAt?: string | null; offerExpiresAt?: string | null; claimedAt?: string | null; registrationId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description People ahead */ ahead: number; message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMeWaitlist: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; eventId: string; eventOptionId: string; variantId?: string | null; sessionId?: string | null; userId: string; quantity: number; /** @description Place in the queue */ position: number; /** @description waiting, offered, claimed, expired, removed, left */ status: string; offeredQuantity?: number | null; offeredAt?: string | null; offerExpiresAt?: string | null; claimedAt?: string | null; registrationId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getWaitlistClaimsToken: { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { eventId?: string | null; eventTitle?: string | null; eventStart?: string | null; eventOptionId: string; optionName: string; variantId?: string | null; variantName?: string | null; sessionId?: string | null; sessionName?: string | null; sessionStart?: string | null; lineName: string; /** @description Places offered */ quantity?: number | null; requested: number; expiresAt?: string | null; name?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdWaitlist: { parameters: { query?: { /** @description `true`/`1`: include everything, not just the current ones */ all?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; eventId: string; eventOptionId: string; variantId?: string | null; sessionId?: string | null; userId: string; quantity: number; /** @description Place in the queue */ position: number; /** @description waiting, offered, claimed, expired, removed, left */ status: string; offeredQuantity?: number | null; offeredAt?: string | null; offerExpiresAt?: string | null; claimedAt?: string | null; registrationId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postWaitlistIdOffer: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Places to offer (default: all they asked for) */ quantity?: number | string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postWaitlistIdMove: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @enum {string} */ direction: "up" | "down"; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postWaitlistIdRemove: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteWaitlistId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdSponsorship: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { enabled: boolean; open?: boolean | null; spotPrice?: number | null; showProgress?: boolean | null; goalSpots?: number | null; spotsFunded?: number | null; sponsors?: unknown; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdSponsorshipPool: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Plus the pool: given, used and places funded */ data: { eventId: string; /** @description Rand */ spotPrice: number; goalSpots?: number | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postSponsorshipsCheckout: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; /** @description Places to fund (or amount) */ spots?: number | string; amount?: number | string; anonymous?: boolean | null; sponsorName?: string | null; message?: string | null; /** @description Not signed in */ name?: string | null; email?: string | null; phone?: string | null; provider?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { checkoutId?: string | null; /** @description Where to send the person to pay (null when the provider takes a form) */ redirectUrl?: string | null; provider?: string | null; /** @description A form to post (PayFast) */ form?: ({ action: string; fields: { [key: string]: string; }; } & { [key: string]: unknown; }) | null; /** @description Rand */ amount: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdConsent: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { [key: string]: unknown; }; /** @description Status → how many */ counts: { [key: string]: number; }; rows: ({ /** @description The young person */ name: string; /** @description not_requested, pending, given, declined */ status: string; parentName?: string | null; parentEmail?: string | null; parentPhone?: string | null; request?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdConsentMedical: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { id?: string; title?: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }; rows: ({ name: string; dateOfBirth?: string | null; parentName?: string | null; parentPhone?: string | null; parentEmail?: string | null; medical?: { [key: string]: unknown; } | null; emergency?: { [key: string]: unknown; } | null; photoConsent?: boolean | null; /** @description Medical details removed after the event */ purged: boolean; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdConsentResend-pending": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; sent: number; pending: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdConsentRerequest: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; created: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postConsent-requestsIdResend": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getConsentToken: { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { status: string; superseded: boolean; expired: boolean; respondedAt?: string | null; attendeeName: string; parentName?: string | null; consentText: string; textVersion?: number | null; event: { title: string; /** @description Date and time (ISO 8601) */ startDate: string; /** @description Date and time (ISO 8601) */ endDate: string; location?: string | null; } & { [key: string]: unknown; }; /** @description What the form asks for */ collect: { medical: boolean; emergency: boolean; photo: boolean; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postConsentToken: { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @enum {string} */ decision: "give" | "decline"; signedName: string; /** @description Must be true */ isGuardian: boolean; medical?: { allergies?: string | null; medication?: string | null; conditions?: string | null; medicalAid?: string | null; } & { [key: string]: unknown; }; emergency?: { name: string; phone: string; relationship?: string | null; } & { [key: string]: unknown; }; photoConsent?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; /** @enum {string} */ status: "given" | "declined"; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getForm-responses": { parameters: { query?: { /** @description Only this event */ eventId?: string; /** @description Only this registration */ registrationId?: string; /** @description Only this person */ userId?: string; /** @description Where the last page ended (its `nextCursor`) */ cursor?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { items: ({ id: string; registrationId: string; attendeeId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; answers?: ({ fieldId: string; value: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; /** @description Pass as `cursor` for the next page */ nextCursor?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getFeedbackSummary: { parameters: { query?: { /** @description These events (comma-separated ids) */ eventIds?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ eventId: string; title: string; /** @description Date and time (ISO 8601) */ startDate: string; anonymous: boolean; sentAt?: string | null; invited: number; responses: number; /** @description % */ responseRate?: number | null; /** @description Each question with its answers summarised */ questions: { [key: string]: unknown; }[]; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getFeedback-formsToken": { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { [key: string]: unknown; }; name: string; intro?: string | null; anonymous: boolean; responded: boolean; fields: ({ id?: string; /** @description rating, multiple_choice, text, yes_no… */ type: string; label: string; isRequired?: boolean | null; helpText?: string | null; options?: string[] | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postFeedback-formsToken": { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Field id → answer */ answers: { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdFeedback: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description null when the event has no feedback form */ data: ({ id: string; eventId: string; sendAt?: string | null; sentAt?: string | null; /** @description checked_in or everyone */ audience: string; anonymous: boolean; intro?: string | null; fields: ({ id?: string; /** @description rating, multiple_choice, text, yes_no… */ type: string; label: string; isRequired?: boolean | null; helpText?: string | null; options?: string[] | null; } & { [key: string]: unknown; })[]; invited?: number | null; /** @description Answers per question */ responses?: unknown; } & { [key: string]: unknown; }) | null; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putEventsIdFeedback: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { sendAt?: string | null; /** @description checked_in or everyone */ audience?: string | null; anonymous?: boolean | null; intro?: string | null; fields: ({ id?: string; /** @description rating, multiple_choice, text, yes_no… */ type: string; label: string; isRequired?: boolean | null; helpText?: string | null; options?: string[] | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description null when the event has no feedback form */ data: ({ id: string; eventId: string; sendAt?: string | null; sentAt?: string | null; /** @description checked_in or everyone */ audience: string; anonymous: boolean; intro?: string | null; fields: ({ id?: string; /** @description rating, multiple_choice, text, yes_no… */ type: string; label: string; isRequired?: boolean | null; helpText?: string | null; options?: string[] | null; } & { [key: string]: unknown; })[]; invited?: number | null; /** @description Answers per question */ responses?: unknown; } & { [key: string]: unknown; }) | null; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteEventsIdFeedback: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdFeedbackSend-now": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { invited: number; message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMeTickets: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description What the QR code holds */ qrCode: string; /** @description People on the ticket */ quantity: number; isUsed: boolean; eventId: string; /** @description The payer */ userId: string; registrationOptionId: string; /** @description A named ticket: the person it's for */ attendeeId?: string | null; holderUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Check-ins */ usages?: ({ id?: string; /** @description Date and time (ISO 8601) */ scannedAt: string; quantityRedeemed: number; sessionId?: string | null; /** @description Ticked present by hand */ manual?: boolean | null; } & { [key: string]: unknown; })[]; event?: ({ id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; } & { [key: string]: unknown; }) | null; /** @description The payer */ user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; attendee?: ({ name: string; } & { [key: string]: unknown; }) | null; registrationOption?: ({ eventOption?: ({ id?: string; eventId?: string; name?: string; description?: string | null; /** @description Rand */ price?: number; isMainTicket?: boolean; stockLimit?: number | null; } & { [key: string]: unknown; }) | null; variant?: ({ name: string; } & { [key: string]: unknown; }) | null; registration?: ({ id?: string; userId?: string; eventId?: string; /** @enum {string} */ status?: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt?: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMeTicketsEmail: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { registrationId?: string; ticketIds?: string[]; channel?: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; /** @description The tickets sent */ ticketIds?: string[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getTicketsScansRecent: { parameters: { query?: { /** @description Only this event */ eventId?: string; /** @description How many per page */ limit?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description Date and time (ISO 8601) */ scannedAt: string; quantityRedeemed: number; scannedBy?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; ticket: { id: string; event: { title: string; } & { [key: string]: unknown; }; registrationOption?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; }; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getTicketsScansStats: { parameters: { query?: { /** @description Only this event */ eventId?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { totalToday: number; myToday: number; lastHour: number; byStaff: ({ scannedById: string; name: string; count: number; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postTicketsSend: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { registrationId?: string | null; /** @description Or registrationId */ ticketIds?: string[]; /** * @description How to send it * @enum {string} */ channel: "email" | "whatsapp" | "both"; /** @description Send here instead */ overrideEmail?: string | null; overridePhone?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; /** @description The tickets sent */ ticketIds?: string[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postTicketsGenerate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { registrationId: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; tickets: ({ id: string; /** @description What the QR code holds */ qrCode: string; /** @description People on the ticket */ quantity: number; isUsed: boolean; eventId: string; /** @description The payer */ userId: string; registrationOptionId: string; /** @description A named ticket: the person it's for */ attendeeId?: string | null; holderUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Check-ins */ usages?: ({ id?: string; /** @description Date and time (ISO 8601) */ scannedAt: string; quantityRedeemed: number; sessionId?: string | null; /** @description Ticked present by hand */ manual?: boolean | null; } & { [key: string]: unknown; })[]; event?: ({ id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; } & { [key: string]: unknown; }) | null; /** @description The payer */ user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; attendee?: ({ name: string; } & { [key: string]: unknown; }) | null; registrationOption?: ({ eventOption?: ({ id?: string; eventId?: string; name?: string; description?: string | null; /** @description Rand */ price?: number; isMainTicket?: boolean; stockLimit?: number | null; } & { [key: string]: unknown; }) | null; variant?: ({ name: string; } & { [key: string]: unknown; }) | null; registration?: ({ id?: string; userId?: string; eventId?: string; /** @enum {string} */ status?: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt?: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postTicketsEmail-sent": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Ids */ ticketIds: string[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getTickets: { parameters: { query?: { /** @description Only this event */ eventId?: string; /** @description Page number, from 1 */ page?: string; /** @description How many per page */ limit?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { data: ({ id: string; /** @description What the QR code holds */ qrCode: string; /** @description People on the ticket */ quantity: number; isUsed: boolean; eventId: string; /** @description The payer */ userId: string; registrationOptionId: string; /** @description A named ticket: the person it's for */ attendeeId?: string | null; holderUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Check-ins */ usages?: ({ id?: string; /** @description Date and time (ISO 8601) */ scannedAt: string; quantityRedeemed: number; sessionId?: string | null; /** @description Ticked present by hand */ manual?: boolean | null; } & { [key: string]: unknown; })[]; event?: ({ id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; } & { [key: string]: unknown; }) | null; /** @description The payer */ user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; attendee?: ({ name: string; } & { [key: string]: unknown; }) | null; registrationOption?: ({ eventOption?: ({ id?: string; eventId?: string; name?: string; description?: string | null; /** @description Rand */ price?: number; isMainTicket?: boolean; stockLimit?: number | null; } & { [key: string]: unknown; }) | null; variant?: ({ name: string; } & { [key: string]: unknown; }) | null; registration?: ({ id?: string; userId?: string; eventId?: string; /** @enum {string} */ status?: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt?: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; total: number; page: number; limit: number; pages: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getTicketsQrQrCode: { parameters: { query?: never; header?: never; path: { /** @description What the ticket's QR code holds */ qrCode: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description What the QR code holds */ qrCode: string; /** @description People on the ticket */ quantity: number; isUsed: boolean; eventId: string; /** @description The payer */ userId: string; registrationOptionId: string; /** @description A named ticket: the person it's for */ attendeeId?: string | null; holderUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Check-ins */ usages?: ({ id?: string; /** @description Date and time (ISO 8601) */ scannedAt: string; quantityRedeemed: number; sessionId?: string | null; /** @description Ticked present by hand */ manual?: boolean | null; } & { [key: string]: unknown; })[]; event?: ({ id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; } & { [key: string]: unknown; }) | null; /** @description The payer */ user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; attendee?: ({ name: string; } & { [key: string]: unknown; }) | null; registrationOption?: ({ eventOption?: ({ id?: string; eventId?: string; name?: string; description?: string | null; /** @description Rand */ price?: number; isMainTicket?: boolean; stockLimit?: number | null; } & { [key: string]: unknown; }) | null; variant?: ({ name: string; } & { [key: string]: unknown; }) | null; registration?: ({ id?: string; userId?: string; eventId?: string; /** @enum {string} */ status?: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt?: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdTickets: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description What the QR code holds */ qrCode: string; /** @description People on the ticket */ quantity: number; isUsed: boolean; eventId: string; /** @description The payer */ userId: string; registrationOptionId: string; /** @description A named ticket: the person it's for */ attendeeId?: string | null; holderUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Check-ins */ usages?: ({ id?: string; /** @description Date and time (ISO 8601) */ scannedAt: string; quantityRedeemed: number; sessionId?: string | null; /** @description Ticked present by hand */ manual?: boolean | null; } & { [key: string]: unknown; })[]; event?: ({ id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; } & { [key: string]: unknown; }) | null; /** @description The payer */ user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; attendee?: ({ name: string; } & { [key: string]: unknown; }) | null; registrationOption?: ({ eventOption?: ({ id?: string; eventId?: string; name?: string; description?: string | null; /** @description Rand */ price?: number; isMainTicket?: boolean; stockLimit?: number | null; } & { [key: string]: unknown; }) | null; variant?: ({ name: string; } & { [key: string]: unknown; }) | null; registration?: ({ id?: string; userId?: string; eventId?: string; /** @enum {string} */ status?: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt?: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getTicket-transfersToken": { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description pending, accepted, declined, cancelled, expired */ status: string; toName: string; /** @description Date and time (ISO 8601) */ expiresAt: string; fromName: string; event: { id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; } & { [key: string]: unknown; }; option: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postTicket-transfersTokenAccept": { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; ticketId: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postTicket-transfersTokenDecline": { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getTicketsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description What the QR code holds */ qrCode: string; /** @description People on the ticket */ quantity: number; isUsed: boolean; eventId: string; /** @description The payer */ userId: string; registrationOptionId: string; /** @description A named ticket: the person it's for */ attendeeId?: string | null; holderUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Check-ins */ usages?: ({ id?: string; /** @description Date and time (ISO 8601) */ scannedAt: string; quantityRedeemed: number; sessionId?: string | null; /** @description Ticked present by hand */ manual?: boolean | null; } & { [key: string]: unknown; })[]; event?: ({ id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; } & { [key: string]: unknown; }) | null; /** @description The payer */ user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; attendee?: ({ name: string; } & { [key: string]: unknown; }) | null; registrationOption?: ({ eventOption?: ({ id?: string; eventId?: string; name?: string; description?: string | null; /** @description Rand */ price?: number; isMainTicket?: boolean; stockLimit?: number | null; } & { [key: string]: unknown; }) | null; variant?: ({ name: string; } & { [key: string]: unknown; }) | null; registration?: ({ id?: string; userId?: string; eventId?: string; /** @enum {string} */ status?: "pending" | "confirmed" | "partial_paid" | "paid" | "cancelled"; discountTotal?: number | null; /** @description What it costs now, after discounts */ totalDueComputed?: number | null; /** @description Date and time (ISO 8601) */ createdAt?: string; user?: ({ id?: string; name: string; email?: string | null; phoneNumber?: string | null; } & { [key: string]: unknown; }) | null; event?: ({ id: string; title: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postTicketsIdTransfer: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Who it goes to */ name: string; email?: string | null; /** @description Email or phone needed */ phone?: string | null; /** @description Youth events */ dateOfBirth?: string | null; gender?: string | null; parentName?: string | null; parentEmail?: string | null; parentPhone?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; requestId: string; /** @description Date and time (ISO 8601) */ expiresAt: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteTicketsIdTransfer: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getTicketsIdTransfers: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; ticketId: string; fromUserId?: string | null; toUserId?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getScan-locks": { parameters: { query: { /** @description Only this event */ eventId: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; eventId: string; sectionId?: string | null; sectionName?: string | null; deviceId: string; deviceName?: string | null; /** @description Who holds it */ user?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; /** @description Date and time (ISO 8601) */ lockedAt: string; snapshotAt?: string | null; lastSyncAt?: string | null; releasedAt?: string | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postScan-locks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; /** @description Just this section (default: the whole event) */ sectionId?: string | null; deviceId: string; deviceName?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; sectionId?: string | null; sectionName?: string | null; deviceId: string; deviceName?: string | null; /** @description Who holds it */ user?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; /** @description Date and time (ISO 8601) */ lockedAt: string; snapshotAt?: string | null; lastSyncAt?: string | null; releasedAt?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getScan-locksReports": { parameters: { query: { /** @description Only this event */ eventId: string; /** @description `true`: only the ones not reviewed yet */ unreviewed?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; accepted?: number | null; duplicates?: number | null; conflicts?: unknown; reviewedAt?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; scanLock: { id: string; eventId: string; sectionId?: string | null; sectionName?: string | null; deviceId: string; deviceName?: string | null; /** @description Who holds it */ user?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; /** @description Date and time (ISO 8601) */ lockedAt: string; snapshotAt?: string | null; lastSyncAt?: string | null; releasedAt?: string | null; } & { [key: string]: unknown; }; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postScan-locksReportsIdReview": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description Date and time (ISO 8601) */ reviewedAt: string; reviewedById: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getScan-locksIdSnapshot": { parameters: { query?: { /** @description This device's id (offline scanning) */ deviceId?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { lock: { id: string; eventId: string; sectionId?: string | null; sectionName?: string | null; deviceId: string; deviceName?: string | null; /** @description Who holds it */ user?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; /** @description Date and time (ISO 8601) */ lockedAt: string; snapshotAt?: string | null; lastSyncAt?: string | null; releasedAt?: string | null; } & { [key: string]: unknown; }; /** @description Date and time (ISO 8601) */ snapshotAt: string; session: ({ id: string; label: string; } & { [key: string]: unknown; }) | null; noSessionToday: boolean; tickets: ({ id: string; qrCode: string; holder: string; bookedBy: string; option: string; variant?: string | null; quantity: number; remaining: number; consentStatus: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postScan-locksIdSync": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { deviceId: string; scans: ({ /** @description The device's id for the scan (repeats are ignored) */ clientScanId: string; qrCode: string; qty?: number | string; scannedAt?: string | null; sessionId?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { accepted: number; duplicates: number; /** @description Scans that clashed with online check-ins */ conflicts: { [key: string]: unknown; }[]; reportId: string; released: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postScan-locksIdForce-release": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteScan-locksId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { deviceId?: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCertificatesVerifyCode: { parameters: { query?: never; header?: never; path: { /** @description The code */ code: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { valid: boolean; revoked?: boolean | null; name?: string | null; event?: string | null; completedOn?: string | null; issuedAt?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMeCertificates: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description For checking it at /verify */ code: string; name: string; /** @description Date and time (ISO 8601) */ issuedAt: string; sessionsAttended?: number | null; totalSessions?: number | null; event?: ({ id?: string; title?: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postCertificatesPreview: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Event title to show */ title?: string | null; config?: { /** @description classic, modern, elegant, simple */ template?: string | null; title?: string | null; /** @description {name} and {event} are filled in */ body?: string | null; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; responses: { /** @description The file */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCertificatesIdPdf: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The file */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postCertificatesIdRevoke: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ ok: true; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdAttendance: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; certificatesEnabled?: boolean | null; certificateConfig?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; }; columns: ({ /** @description Session id, or `event` */ id: string; label: string; } & { [key: string]: unknown; })[]; rows: ({ ticketId: string; /** @description Picked/ticked sessions (null: all) */ bookedSessions: string[] | null; sessionTickets: { [key: string]: string; } | null; name: string; bookedBy: string; email: string; phone: string; option: string; variant?: string | null; quantity: number; /** @description Session id (or `event`) → people checked in */ checkIns: { [key: string]: number; }; attended: number; total: number; /** @description Meets the certificate rule */ completed: boolean; certificate?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; })[]; totals: { [key: string]: number; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdAttendance: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { ticketId: string; /** @description A session id, or `event` on a single-date event */ sessionId: string; present: boolean; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ ok: true; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdAttendanceExport: { parameters: { query?: { /** @description File type, e.g. `pdf` or `xlsx` */ format?: string; /** @description Multi-day events: the session (default: today's) */ sessionId?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The file */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdCertificates: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Just this person (default: everyone who qualifies) */ ticketId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { issued: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdCertificatesSend: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Just this one (default: every one not sent yet) */ certificateId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { sent: number; skipped: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getEventsIdCertificates.pdf": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The file */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getMeAllocation-groups": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { medicalShown: boolean; groups: ({ id: string; name: string; capacity?: number | null; gender?: string | null; setName: string; event: { id?: string; title?: string; startDate?: string | null; endDate?: string | null; } & { [key: string]: unknown; }; members: ({ attendeeId?: string; name: string; gender?: string | null; dateOfBirth?: string | null; groupId?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdAllocations: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { [key: string]: unknown; }; sets: ({ id: string; eventId: string; name: string; showOnTicket: boolean; order: number; groups: ({ id: string; setId: string; name: string; capacity?: number | null; gender?: string | null; leaderUserId?: string | null; minAge?: number | null; maxAge?: number | null; ratio?: number | null; order: number; } & { [key: string]: unknown; })[]; assignments: ({ attendeeId: string; groupId: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; attendees: ({ id: string; name: string; gender?: string | null; dateOfBirth?: string | null; registrationId: string; bookedBy: string; } & { [key: string]: unknown; })[]; leaders: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; })[]; /** @description Places with no name yet */ unnamedPlaces: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postAllocation-sets": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; /** @description e.g. Cabins, Buses */ name: string; showOnTicket?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; showOnTicket: boolean; order: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteAllocation-setsId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "patchAllocation-setsId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; showOnTicket?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; showOnTicket: boolean; order: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getAllocation-setsIdLists": { parameters: { query?: { /** @description `true`: include medical notes (supervisors; logged) */ medical?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { set: { id: string; name: string; } & { [key: string]: unknown; }; event: { [key: string]: unknown; }; groups: ({ id: string; name: string; capacity?: number | null; gender?: string | null; leader?: string | null; members: ({ attendeeId?: string; name: string; gender?: string | null; dateOfBirth?: string | null; groupId?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postAllocation-setsIdGroups": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; capacity?: number | string | null; gender?: ("male" | "female" | "mixed") | null; /** @description A staff member */ leaderUserId?: string | null; minAge?: number | string | null; maxAge?: number | string | null; /** @description Children per leader */ ratio?: number | string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; setId: string; name: string; capacity?: number | null; gender?: string | null; leaderUserId?: string | null; minAge?: number | null; maxAge?: number | null; ratio?: number | null; order: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "putAllocation-setsIdAssignments": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { attendeeId: string; /** @description null takes them out */ groupId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteAllocation-setsIdAssignments": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postAllocation-setsIdAuto": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description Keep each booking together, or spread them * @enum {string} */ mode?: "together" | "split"; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { placed: number; unplaced: number; message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteAllocation-groupsId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "patchAllocation-groupsId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; capacity?: number | string | null; gender?: ("male" | "female" | "mixed") | null; /** @description A staff member */ leaderUserId?: string | null; minAge?: number | string | null; maxAge?: number | string | null; /** @description Children per leader */ ratio?: number | string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; setId: string; name: string; capacity?: number | null; gender?: string | null; leaderUserId?: string | null; minAge?: number | null; maxAge?: number | null; ratio?: number | null; order: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCorrectionsEventsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { id: string; title: string; startDate: unknown; endDate: unknown; closed: boolean; formRequired: boolean; sessions: { id: string; label: string; startsAt: unknown; }[]; }; registrations: { id: string; status: string; createdAt: unknown; user: { id: string; name: string; email: string | null; phoneNumber: string | null; }; totalDue: number; paid: number; balance: number; /** @description Places booked (every line) */ places: number; /** @description Places with a ticket */ ticketPlaces: number; /** @description Paid (or released unpaid) but not every place has a ticket */ missingTickets: boolean; /** @description Attendee forms still holding the tickets back */ formsNeeded: number; /** @description The form was left for later */ formWaived: boolean; /** @description Tickets issued before it was paid */ ticketsReleased: boolean; /** @description Balance written off */ complimentary: number; tickets: { id: string; qrCode: string; /** @description Ticket option, variant and (a picked session) the session */ label: string; isMainTicket: boolean; /** @description Who it's for */ name: string; quantity: number; /** @description The sessions it covers (`event` on a single-date event) */ sessionIds: string[]; /** @description People checked in, per session */ checkedIn: { [key: string]: number; }; }[]; }[]; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postCorrectionsEventsIdIssue-missing": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Send the new tickets to the attendee (off by default) */ send?: boolean; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { registrations: number; tickets: number; failed: { id: string; name: string; message: string; }[]; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postCorrectionsRegistrationsIdTickets: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { skipForm?: boolean; payLater?: boolean; /** @description Send the new tickets to the attendee (off by default) */ send?: boolean; /** @description Why — kept in the audit log */ reason?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { ticketsIssued: number; registration: { id: string; status: string; createdAt: unknown; user: { id: string; name: string; email: string | null; phoneNumber: string | null; }; totalDue: number; paid: number; balance: number; /** @description Places booked (every line) */ places: number; /** @description Places with a ticket */ ticketPlaces: number; /** @description Paid (or released unpaid) but not every place has a ticket */ missingTickets: boolean; /** @description Attendee forms still holding the tickets back */ formsNeeded: number; /** @description The form was left for later */ formWaived: boolean; /** @description Tickets issued before it was paid */ ticketsReleased: boolean; /** @description Balance written off */ complimentary: number; tickets: { id: string; qrCode: string; /** @description Ticket option, variant and (a picked session) the session */ label: string; isMainTicket: boolean; /** @description Who it's for */ name: string; quantity: number; /** @description The sessions it covers (`event` on a single-date event) */ sessionIds: string[]; /** @description People checked in, per session */ checkedIn: { [key: string]: number; }; }[]; }; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postCorrectionsRegistrationsIdComplimentary: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { skipForm?: boolean; /** @description Send the new tickets to the attendee (off by default) */ send?: boolean; /** @description Why — kept in the audit log */ reason?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { amount: number; ticketsIssued: number; registration: { id: string; status: string; createdAt: unknown; user: { id: string; name: string; email: string | null; phoneNumber: string | null; }; totalDue: number; paid: number; balance: number; /** @description Places booked (every line) */ places: number; /** @description Places with a ticket */ ticketPlaces: number; /** @description Paid (or released unpaid) but not every place has a ticket */ missingTickets: boolean; /** @description Attendee forms still holding the tickets back */ formsNeeded: number; /** @description The form was left for later */ formWaived: boolean; /** @description Tickets issued before it was paid */ ticketsReleased: boolean; /** @description Balance written off */ complimentary: number; tickets: { id: string; qrCode: string; /** @description Ticket option, variant and (a picked session) the session */ label: string; isMainTicket: boolean; /** @description Who it's for */ name: string; quantity: number; /** @description The sessions it covers (`event` on a single-date event) */ sessionIds: string[]; /** @description People checked in, per session */ checkedIn: { [key: string]: number; }; }[]; }; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postCorrectionsTicketsIdCheck-in": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Multi-day events: the session */ sessionId?: string | null; /** @description How many (default: everyone left on the ticket) */ people?: number | null; /** @description false undoes it */ present?: boolean; /** @description Why — kept in the audit log */ reason?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { checkedIn: number; quantity: number; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postRegistrationsIdForm-later": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { notify?: boolean; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { ticketsIssued: number; sentTo: string[]; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMeFamily: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { family: ({ id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }) | null; /** @description The family QR code (shown at the desk) */ qrToken?: string | null; /** @description Collection codes for children checked in now */ codes: { [key: string]: unknown; }[]; /** @description Recent "come to the room" messages */ pages: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMeFamily: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { family: ({ id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }) | null; /** @description The family QR code (shown at the desk) */ qrToken?: string | null; /** @description Collection codes for children checked in now */ codes: { [key: string]: unknown; }[]; /** @description Recent "come to the room" messages */ pages: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteMeFamily: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description What happened: left, or the family was deleted as the last parent */ data: { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchMeFamily: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMeFamilyChildren: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { firstName: string; lastName?: string | null; dateOfBirth?: string | null; /** @description male or female (anything else: not given) */ gender?: string | null; allergies?: string | null; medicalNotes?: string | null; /** @description Kept encrypted, like the medical notes */ custodyNotes?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putMeFamilyChildrenId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { firstName?: string; lastName?: string | null; dateOfBirth?: string | null; /** @description male or female (anything else: not given) */ gender?: string | null; allergies?: string | null; medicalNotes?: string | null; /** @description Kept encrypted, like the medical notes */ custodyNotes?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteMeFamilyChildrenId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMeFamilyAdults: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name: string; phone?: string | null; relationship?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putMeFamilyAdultsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name: string; phone?: string | null; relationship?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteMeFamilyAdultsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getKidsSetup-events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; kidsCheckIn?: boolean | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getKidsEvents: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id?: string; title?: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate?: string; /** @description Date and time (ISO 8601) */ endDate?: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdKidsSettings: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { id: string; title: string; scheduleType?: string | null; kidsCheckIn: boolean; kidsOptionId?: string | null; kidsRoomSetId?: string | null; } & { [key: string]: unknown; }; options: ({ id?: string; eventId?: string; name?: string; description?: string | null; /** @description Rand */ price?: number; isMainTicket?: boolean; stockLimit?: number | null; } & { [key: string]: unknown; })[]; /** @description Allocation sets that can be the rooms */ sets: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putEventsIdKidsSettings: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { enabled?: boolean | null; /** @description The kids ticket (`new` makes a free one; null: none) */ optionId?: string | null; /** @description The allocation set used as rooms */ roomSetId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The saved set-up, as GET answers */ data: { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdKidsBoard: { parameters: { query?: { /** @description Multi-day events: the session (default: today's) */ sessionId?: string; /** @description `1` also writes it to the access log (a list with personal details) */ log?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { [key: string]: unknown; }; /** @description The day or session it's for */ occasion: string; sessionId?: string | null; sessionLabel?: string | null; rooms: ({ id: string; name: string; minAge?: number | null; maxAge?: number | null; capacity?: number | null; ratio?: number | null; order?: number | null; leaderNames?: string[]; /** @description Ids */ leaderIds?: string[]; } & { [key: string]: unknown; })[]; /** @description Children checked in, with room and code */ checkIns: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdKidsFamilies: { parameters: { query?: { /** @description Text to search for */ q?: string; /** @description Multi-day events: the session (default: today's) */ sessionId?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdKidsFamilies: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; parent: { name: string; email?: string | null; /** @description Email or phone needed: the collection code is sent there */ phone?: string | null; } & { [key: string]: unknown; }; children?: ({ firstName: string; lastName?: string | null; dateOfBirth?: string | null; /** @description male or female (anything else: not given) */ gender?: string | null; allergies?: string | null; medicalNotes?: string | null; /** @description Kept encrypted, like the medical notes */ custodyNotes?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdKidsFamiliesQrToken: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdKidsFamiliesFamilyId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; /** @description The family's id */ familyId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdKidsFamiliesFamilyIdParents: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; /** @description The family's id */ familyId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name: string; email?: string | null; /** @description Email or phone needed: the collection code is sent there */ phone?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdKidsFamiliesFamilyIdChildren: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; /** @description The family's id */ familyId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { firstName: string; lastName?: string | null; dateOfBirth?: string | null; /** @description male or female (anything else: not given) */ gender?: string | null; allergies?: string | null; medicalNotes?: string | null; /** @description Kept encrypted, like the medical notes */ custodyNotes?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putEventsIdKidsFamiliesFamilyIdChildrenChildId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; /** @description The family's id */ familyId: string; /** @description The child's id */ childId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { firstName?: string; lastName?: string | null; dateOfBirth?: string | null; /** @description male or female (anything else: not given) */ gender?: string | null; allergies?: string | null; medicalNotes?: string | null; /** @description Kept encrypted, like the medical notes */ custodyNotes?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdKidsFamiliesFamilyIdAdults: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; /** @description The family's id */ familyId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name: string; phone?: string | null; relationship?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdKidsCheck-in": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { familyId: string; sessionId?: string | null; /** @description Who, and into which room (default: by age) */ children: ({ childId: string; roomId?: string | null; } & { [key: string]: unknown; })[]; /** @description Send the code to this adult too */ sendToAdultId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The collection code */ code: string; qr: string; occasion: string; family: { id: string; name: string; } & { [key: string]: unknown; }; checkIns: ({ id: string; name: string; firstName: string; room?: { [key: string]: unknown; } | null; already: boolean; /** @description Write this on the sticker */ sticker?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdKidsCheck-out": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { code: string; /** @description Just these children (default: all on the code) */ checkInIds?: string[]; /** @description Who collected them */ collectedBy?: string | null; roomId?: string | null; sessionId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { checkedOut: ({ id: string; name: string; room?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdKidsCodeCode: { parameters: { query?: { /** @description Multi-day events: the session (default: today's) */ sessionId?: string; }; header?: never; path: { /** @description The id */ id: string; /** @description The code */ code: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { code: string; found: boolean; family?: { [key: string]: unknown; } | null; children: ({ id: string; name: string; room?: { [key: string]: unknown; } | null; checkedOutAt?: string | null; collectedBy?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdKidsDuty: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { roomId: string; sessionId?: string | null; /** @description false: off duty */ on?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { roomId: string; on: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdKidsOffline: { parameters: { query?: { /** @description This device's id (offline scanning) */ deviceId?: string; /** @description Multi-day events: the session (default: today's) */ sessionId?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { [key: string]: unknown; }; /** @description The day or session it's for */ occasion: string; sessionId?: string | null; sessionLabel?: string | null; rooms: ({ id: string; name: string; minAge?: number | null; maxAge?: number | null; capacity?: number | null; ratio?: number | null; order?: number | null; leaderNames?: string[]; /** @description Ids */ leaderIds?: string[]; } & { [key: string]: unknown; })[]; /** @description Children checked in, with room and code */ checkIns: { [key: string]: unknown; }[]; families: ({ id: string; name: string; parents: ({ userId: string; name: string; phone?: string | null; email?: string | null; } & { [key: string]: unknown; })[]; children: ({ id: string; firstName: string; lastName: string; name: string; dateOfBirth?: string | null; age?: number | null; gender?: string | null; allergies?: string | null; hasMedical: boolean; /** @description There are custody notes */ hasCustody: boolean; /** @description Only where notes may be shown */ medicalNotes?: string | null; custodyNotes?: string | null; lastCheckInAt?: string | null; } & { [key: string]: unknown; })[]; /** @description Others who may collect the children */ adults: ({ name: string; phone?: string | null; relationship?: string | null; id: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; /** @description Codes reserved for this device */ codes: { [key: string]: unknown; }[]; /** @description Date and time (ISO 8601) */ downloadedAt: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postEventsIdKidsSync: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { deviceId: string; sessionId?: string | null; checkIns?: { [key: string]: unknown; }[]; checkOuts?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { checkedIn: number; checkedOut: number; conflicts: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postKidsCheck-insIdOverride": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { reason: string; collectedBy: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description Date and time (ISO 8601) */ checkedOutAt: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postKidsCheck-insIdPage": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { message?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description Channels used */ sent: string[]; text: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "putKidsCheck-insIdRoom": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { roomId: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; roomId: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postKidsAlertsIdResolve: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { resolved: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMeVolunteering: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { slots: ({ slotId: string; role: { [key: string]: unknown; }; event: { [key: string]: unknown; }; shift: { /** @description Date and time (ISO 8601) */ startsAt: string; /** @description Date and time (ISO 8601) */ endsAt: string; text: string; hours: number; } & { [key: string]: unknown; }; checkedInAt?: string | null; canCheckIn: boolean; past: boolean; swapId?: string | null; hasTicket: boolean; } & { [key: string]: unknown; })[]; /** @description Slots others want covered */ cover: { [key: string]: unknown; }[]; events: ({ id: string; title: string; /** @description Date and time (ISO 8601) */ startDate: string; /** @description Date and time (ISO 8601) */ endDate: string; location?: string | null; roles: number; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getEventsIdVolunteer-roles": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { [key: string]: unknown; }; sessions: ({ id: string; label: string; /** @description Date and time (ISO 8601) */ startsAt: string; /** @description Date and time (ISO 8601) */ endsAt: string; } & { [key: string]: unknown; })[]; roles: ({ id: string; eventId: string; sessionId?: string | null; sessionLabel?: string | null; name: string; description: string; startsAt?: string | null; endsAt?: string | null; shift: { /** @description Date and time (ISO 8601) */ startsAt: string; /** @description Date and time (ISO 8601) */ endsAt: string; text: string; hours: number; } & { [key: string]: unknown; }; kidsRoom?: { [key: string]: unknown; } | null; order: number; past: boolean; needed?: number | null; filled?: number | null; /** @description My place in it */ mine: ({ slotId: string; checkedInAt?: string | null; swapId?: string | null; } & { [key: string]: unknown; }) | null; coverNeeded: ({ swapId: string; note: string; } & { [key: string]: unknown; })[]; /** @description Staff only */ volunteers?: ({ slotId: string; userId: string; name: string; phone?: string | null; email?: string | null; assignedBy?: string | null; checkedInAt?: string | null; checkedInBy?: string | null; checkInMethod?: string | null; swapOpen: boolean; hasTicket: boolean; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; totals: { needed?: number | null; filled?: number | null; /** @description % */ fillRate?: number | null; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdVolunteer-roles": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name: string; description?: string | null; /** @description A multi-day event: the session */ sessionId?: string | null; startsAt?: string | null; /** @description Default: the event's or session's times */ endsAt?: string | null; /** @description How many people */ needed?: number | string | null; /** @description Serving in a kids room: counts as a leader on duty */ kidsRoomId?: string | null; order?: number | string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; description?: string | null; sessionId?: string | null; startsAt?: string | null; endsAt?: string | null; needed?: number | null; kidsRoomId?: string | null; order: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postVolunteer-rolesIdSign-up": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { slotId: string; /** @description A free volunteer ticket was issued */ ticket: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteVolunteer-slotsId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postVolunteer-slotsIdSwap": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { note?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { swapId: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteVolunteer-swapsId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ cancelled: true; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postVolunteer-swapsIdAccept": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { slotId: string; role: string; event: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postVolunteeringCheck-in": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description What the QR code holds */ qr: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { id: string; title: string; } & { [key: string]: unknown; }; checkedIn: ({ role: string; kidsRoom?: string | null; } & { [key: string]: unknown; })[]; already: string[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getVolunteeringEvents: { parameters: { query?: { /** @description `true`/`1`: include everything, not just the current ones */ all?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; title: string; /** @description Date and time (ISO 8601) */ startDate: string; /** @description Date and time (ISO 8601) */ endDate: string; scheduleType?: string | null; campusId?: string | null; roles: number; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getVolunteeringHours: { parameters: { query?: { /** @description On or after (ISO date or date-time) */ from?: string; /** @description On or before (ISO date or date-time) */ to?: string; /** @description Only this event */ eventId?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ userId?: string; name: string; hours: number; shifts?: number | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdVolunteers: { parameters: { query?: { /** @description `1` also writes it to the access log (a list with personal details) */ log?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { [key: string]: unknown; }; sessions: ({ id: string; label: string; /** @description Date and time (ISO 8601) */ startsAt: string; /** @description Date and time (ISO 8601) */ endsAt: string; } & { [key: string]: unknown; })[]; roles: ({ id: string; eventId: string; sessionId?: string | null; sessionLabel?: string | null; name: string; description: string; startsAt?: string | null; endsAt?: string | null; shift: { /** @description Date and time (ISO 8601) */ startsAt: string; /** @description Date and time (ISO 8601) */ endsAt: string; text: string; hours: number; } & { [key: string]: unknown; }; kidsRoom?: { [key: string]: unknown; } | null; order: number; past: boolean; needed?: number | null; filled?: number | null; /** @description My place in it */ mine: ({ slotId: string; checkedInAt?: string | null; swapId?: string | null; } & { [key: string]: unknown; }) | null; coverNeeded: ({ swapId: string; note: string; } & { [key: string]: unknown; })[]; /** @description Staff only */ volunteers?: ({ slotId: string; userId: string; name: string; phone?: string | null; email?: string | null; assignedBy?: string | null; checkedInAt?: string | null; checkedInBy?: string | null; checkInMethod?: string | null; swapOpen: boolean; hasTicket: boolean; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; totals: { needed?: number | null; filled?: number | null; /** @description % */ fillRate?: number | null; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdVolunteersQr: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { token: string; /** @description Put this in the QR code */ qr: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getEventsIdVolunteersSettings: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { event: { id: string; title: string; volunteerOptionId?: string | null; } & { [key: string]: unknown; }; options: ({ id?: string; eventId?: string; name?: string; description?: string | null; /** @description Rand */ price?: number; isMainTicket?: boolean; stockLimit?: number | null; } & { [key: string]: unknown; })[]; kidsRooms: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putEventsIdVolunteersSettings: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The free volunteer ticket (null: none) */ optionId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The saved set-up, as GET answers */ data: { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteVolunteer-rolesId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; /** @description People who were in it (told by message) */ volunteers: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "patchVolunteer-rolesId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string; description?: string | null; /** @description A multi-day event: the session */ sessionId?: string | null; startsAt?: string | null; /** @description Default: the event's or session's times */ endsAt?: string | null; /** @description How many people */ needed?: number | string | null; /** @description Serving in a kids room: counts as a leader on duty */ kidsRoomId?: string | null; order?: number | string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; eventId: string; name: string; description?: string | null; sessionId?: string | null; startsAt?: string | null; endsAt?: string | null; needed?: number | null; kidsRoomId?: string | null; order: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postVolunteer-rolesIdAssign": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { userId: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { slotId: string; /** @description A free volunteer ticket was issued */ ticket: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postVolunteer-slotsIdCheck-in": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { undo?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { slotId: string; changed: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postVolunteer-slotsIdRemove": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAuthLoginCodeResend: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { challengeId: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { challengeId: string; /** @enum {string} */ method: "email" | "whatsapp"; /** @description Where the code went, partly hidden */ destination: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAuthPasswordForgot: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { email: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAuthPasswordReset: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description From the link */ token: string; password: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAuthActivate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description From the link */ token: string; /** @description At least 8 characters */ password: string; acceptTerms?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message?: string | null; id: string; name: string; email: string; role: string; /** @description A new sign-in token */ token: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMeSessionsRevoke: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; /** @description A new token for this device (the old one stops working) */ token: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMeClose: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { password: string; /** @description Also ask for my personal information to be deleted */ deleteData?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMeActivity: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description login, password_changed, two_factor_enabled… */ type: string; device?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postMeVerify-password": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { password: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ ok: true; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postMeTwo-factorEnable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @enum {string} */ method: "email" | "whatsapp"; password: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { challengeId: string; /** @enum {string} */ method: "email" | "whatsapp"; /** @description Where the code went, partly hidden */ destination: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postMeTwo-factorConfirm": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { challengeId: string; code: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ twoFactorEnabled: true; twoFactorMethod: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postMeTwo-factorDisable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { password: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ twoFactorEnabled: false; twoFactorMethod: null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getUsersExists: { parameters: { query?: { /** @description An email address */ email?: string; /** @description A phone number */ phone?: string; /** @description A phone number */ phoneNumber?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { exists: boolean; hasEmail?: boolean | null; hasPhone?: boolean | null; user?: ({ id: string; name: string; email?: string | null; phoneNumber?: string | null; notificationPreference?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getUsers: { parameters: { query?: { /** @description Page number, from 1 */ page?: string; /** @description How many per page */ limit?: string; /** @description Text to search for */ search?: string; /** @description admin, supervisor, staff or user */ role?: string; /** @description `true` or `false` */ isActive?: string; /** @description Campus id or slug (`all` for every campus) */ campus?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { data: ({ id: string; name: string; email: string; phoneNumber?: string | null; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; isActive?: boolean | null; notificationPreference?: ("email" | "whatsapp" | "both") | null; homeCampusId?: string | null; createdAt?: string | null; } & { [key: string]: unknown; })[]; total: number; page: number; limit: number; pages: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getUsersId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; email: string; phoneNumber?: string | null; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; isActive?: boolean | null; notificationPreference?: ("email" | "whatsapp" | "both") | null; homeCampusId?: string | null; createdAt?: string | null; /** @description Campuses they're limited to */ scopedCampusIds?: string[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteUsersId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; patchUsersId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; email?: string | null; phoneNumber?: string | null; /** @description admin, supervisor, staff or user */ role?: string | null; isActive?: boolean | null; /** @description Set a new password */ password?: string | null; /** @description email, whatsapp or both */ notificationPreference?: string | null; /** @description Only to turn it off */ twoFactorEnabled?: boolean | null; /** @description Limit staff to these campuses (empty: all) */ scopedCampusIds?: string[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; email: string; phoneNumber?: string | null; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; isActive?: boolean | null; notificationPreference?: ("email" | "whatsapp" | "both") | null; homeCampusId?: string | null; createdAt?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postUsersIdSessionsRevoke: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postUsersIdAnonymize: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getEvent-listing": { parameters: { query?: { /** @description Campus id or slug (`all` for every campus) */ campus?: string; /** @description Event series slug */ series?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; title: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate: string; /** @description Date and time (ISO 8601) */ endDate: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; eventOptions?: ({ id: string; eventId?: string; name: string; description?: string | null; /** @description Rand */ price: number; isMainTicket: boolean; stockLimit?: number | null; } & { [key: string]: unknown; })[]; isSoldOut?: boolean | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getAdminEvents: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; title: string; description?: string | null; /** @description Date and time (ISO 8601) */ startDate: string; /** @description Date and time (ISO 8601) */ endDate: string; location?: string | null; price?: number | null; isActive?: boolean | null; isHidden?: boolean | null; imageUrl?: string | null; campusId?: string | null; scheduleType?: ("single" | "sessions") | null; cashupStatus?: ("open" | "closed") | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdEmail-attendees": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { subject?: string | null; html?: string | null; /** @description subject and html or text, unless template is tickets */ text?: string | null; /** * @description tickets: send everyone their tickets; the reminders fill in a standard message * @enum {string} */ template?: "custom" | "tickets" | "payment_reminder" | "event_reminder"; filter?: { /** @description any, paid, unpaid, checked_in, not_checked_in… */ status?: string | null; /** @description Ids */ attendeeIds?: string[]; /** @description Ids */ registrationIds?: string[]; /** @description People in one room or group */ allocationGroupId?: string | null; name?: string | null; email?: string | null; phone?: string | null; /** * @description Sponsors of the event instead * @enum {string} */ audience?: "sponsors"; } & { [key: string]: unknown; }; /** @description Only say who it would reach */ dryRun?: boolean | null; /** * @description update: about something they booked (always sent). news: needs their news consent * @enum {string} */ kind?: "update" | "news"; /** @description Promote another event (news) */ promoEventId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { eventId?: string | null; kind?: string | null; matched: number; /** @description Left out: no news consent */ skipped?: number | null; /** @description The first 20 */ recipients?: { [key: string]: unknown; }[]; queued?: number | null; template?: string | null; sent?: number | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdEmail-attendeesSchedule": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { subject?: string | null; html?: string | null; /** @description subject and html or text, unless template is tickets */ text?: string | null; /** * @description tickets: send everyone their tickets; the reminders fill in a standard message * @enum {string} */ template?: "custom" | "tickets" | "payment_reminder" | "event_reminder"; filter?: { /** @description any, paid, unpaid, checked_in, not_checked_in… */ status?: string | null; /** @description Ids */ attendeeIds?: string[]; /** @description Ids */ registrationIds?: string[]; /** @description People in one room or group */ allocationGroupId?: string | null; name?: string | null; email?: string | null; phone?: string | null; /** * @description Sponsors of the event instead * @enum {string} */ audience?: "sponsors"; } & { [key: string]: unknown; }; /** @description Only say who it would reach */ dryRun?: boolean | null; /** * @description update: about something they booked (always sent). news: needs their news consent * @enum {string} */ kind?: "update" | "news"; /** @description Promote another event (news) */ promoEventId?: string | null; /** @description Date and time (ISO 8601) */ scheduledAt: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; job: { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdWhatsapp-attendees": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Required unless template is tickets */ message?: string | null; /** @enum {string} */ template?: "custom" | "tickets" | "payment_reminder" | "event_reminder"; filter?: { /** @description any, paid, unpaid, checked_in, not_checked_in… */ status?: string | null; /** @description Ids */ attendeeIds?: string[]; /** @description Ids */ registrationIds?: string[]; /** @description People in one room or group */ allocationGroupId?: string | null; name?: string | null; email?: string | null; phone?: string | null; /** * @description Sponsors of the event instead * @enum {string} */ audience?: "sponsors"; } & { [key: string]: unknown; }; dryRun?: boolean | null; /** * @description update: about something they booked (always sent). news: needs their news consent * @enum {string} */ kind?: "update" | "news"; promoEventId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { eventId?: string | null; kind?: string | null; matched: number; /** @description Left out: no news consent */ skipped?: number | null; /** @description The first 20 */ recipients?: { [key: string]: unknown; }[]; queued?: number | null; template?: string | null; sent?: number | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postEventsIdWhatsapp-attendeesSchedule": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Required unless template is tickets */ message?: string | null; /** @enum {string} */ template?: "custom" | "tickets" | "payment_reminder" | "event_reminder"; filter?: { /** @description any, paid, unpaid, checked_in, not_checked_in… */ status?: string | null; /** @description Ids */ attendeeIds?: string[]; /** @description Ids */ registrationIds?: string[]; /** @description People in one room or group */ allocationGroupId?: string | null; name?: string | null; email?: string | null; phone?: string | null; /** * @description Sponsors of the event instead * @enum {string} */ audience?: "sponsors"; } & { [key: string]: unknown; }; dryRun?: boolean | null; /** * @description update: about something they booked (always sent). news: needs their news consent * @enum {string} */ kind?: "update" | "news"; promoEventId?: string | null; /** @description Date and time (ISO 8601) */ scheduledAt: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; job: { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postBroadcastsEmailPreview: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Chosen accounts */ userIds?: string[]; /** @description Typed-in addresses, separated by commas or new lines */ emails?: string | null; /** @description Everyone registered for this event */ eventId?: string | null; /** * @description Default news * @enum {string} */ kind?: "update" | "news"; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { eventId?: string | null; kind?: string | null; matched: number; /** @description Left out: no news consent */ skipped?: number | null; /** @description The first 20 */ recipients?: { [key: string]: unknown; }[]; queued?: number | null; template?: string | null; sent?: number | null; event?: { [key: string]: unknown; } | null; placeholders?: string[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postBroadcastsEmailSend: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Chosen accounts */ userIds?: string[]; /** @description Typed-in addresses, separated by commas or new lines */ emails?: string | null; /** @description Everyone registered for this event */ eventId?: string | null; /** * @description Default news * @enum {string} */ kind?: "update" | "news"; subject: string; html?: string | null; text?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { eventId?: string | null; kind?: string | null; matched: number; /** @description Left out: no news consent */ skipped?: number | null; /** @description The first 20 */ recipients?: { [key: string]: unknown; }[]; queued?: number | null; template?: string | null; sent?: number | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postBroadcastsEmailSchedule: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Chosen accounts */ userIds?: string[]; /** @description Typed-in addresses, separated by commas or new lines */ emails?: string | null; /** @description Everyone registered for this event */ eventId?: string | null; /** * @description Default news * @enum {string} */ kind?: "update" | "news"; subject: string; html?: string | null; text?: string | null; /** @description Date and time (ISO 8601) */ scheduledAt: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; job: { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postBroadcastsWhatsappPreview: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Chosen accounts */ userIds?: string[]; /** @description Typed-in numbers, separated by commas or new lines */ phones?: string | null; /** @description Everyone registered for this event */ eventId?: string | null; /** * @description Default news * @enum {string} */ kind?: "update" | "news"; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { eventId?: string | null; kind?: string | null; matched: number; /** @description Left out: no news consent */ skipped?: number | null; /** @description The first 20 */ recipients?: { [key: string]: unknown; }[]; queued?: number | null; template?: string | null; sent?: number | null; event?: { [key: string]: unknown; } | null; placeholders?: string[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postBroadcastsWhatsappSend: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Chosen accounts */ userIds?: string[]; /** @description Typed-in numbers, separated by commas or new lines */ phones?: string | null; /** @description Everyone registered for this event */ eventId?: string | null; /** * @description Default news * @enum {string} */ kind?: "update" | "news"; message: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { eventId?: string | null; kind?: string | null; matched: number; /** @description Left out: no news consent */ skipped?: number | null; /** @description The first 20 */ recipients?: { [key: string]: unknown; }[]; queued?: number | null; template?: string | null; sent?: number | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postBroadcastsWhatsappSchedule: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Chosen accounts */ userIds?: string[]; /** @description Typed-in numbers, separated by commas or new lines */ phones?: string | null; /** @description Everyone registered for this event */ eventId?: string | null; /** * @description Default news * @enum {string} */ kind?: "update" | "news"; message: string; /** @description Date and time (ISO 8601) */ scheduledAt: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; job: { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getScheduled-messages": { parameters: { query?: { /** @description Only this status */ status?: string; /** @description Only this event */ eventId?: string; /** @description email or whatsapp */ channel?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { jobs: ({ id: string; /** @description broadcast or attendees */ kind: string; eventId?: string | null; broadcast: boolean; channel: ("email" | "whatsapp") | string; recipient?: string | null; /** @description Date and time (ISO 8601) */ scheduledAt: string; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description queued, sent, failed, cancelled */ status: string; attempts: number; sentAt?: string | null; lastError?: string | null; subject: string; html: string; text: string; message: string; hasHtml: boolean; hasText: boolean; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteScheduled-messagesId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "patchScheduled-messagesId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { scheduledAt?: string | null; subject?: string | null; html?: string | null; text?: string | null; /** @description WhatsApp */ message?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; job: { id: string; /** @description broadcast or attendees */ kind: string; eventId?: string | null; broadcast: boolean; channel: ("email" | "whatsapp") | string; recipient?: string | null; /** @description Date and time (ISO 8601) */ scheduledAt: string; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description queued, sent, failed, cancelled */ status: string; attempts: number; sentAt?: string | null; lastError?: string | null; subject: string; html: string; text: string; message: string; hasHtml: boolean; hasText: boolean; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAutomationsSchedule: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { eventId: string; jobs: ({ /** @description Date and time (ISO 8601) */ scheduledAt: string; subject: string; html?: string | null; text?: string | null; /** @enum {string} */ audience?: "sponsors"; promoEventId?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; jobs: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getWhatsappConfig: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { tokenMasked: string; instanceId: string; hasToken: boolean; hasInstance: boolean; configured: boolean; webhookUrl?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putWhatsappConfig: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { token?: string | null; instanceId?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postWhatsappInstance: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Plus what the WhatsApp service answered */ data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deleteWhatsappInstance: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Plus what the WhatsApp service answered */ data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getWhatsappStatus: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The WhatsApp service's status answer */ data: { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getWhatsappQr: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The WhatsApp service's answer, with the QR code image */ data: { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postWhatsappRequest-code": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { phoneNumber: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The WhatsApp service's answer */ data: { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postWhatsappLogout: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The WhatsApp service's answer */ data: { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postWhatsappStart: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The WhatsApp service's answer */ data: { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postWhatsappRestart: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The WhatsApp service's answer */ data: { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getBanner: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; /** @description info, warning, success, error */ type: string; liveFrom?: string | null; liveTill?: string | null; } & { [key: string]: unknown; }; }; }; }; }; }; putBanner: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { message?: string; /** @description info, warning, success, error */ type?: string; liveFrom?: string | null; liveTill?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; /** @description info, warning, success, error */ type: string; liveFrom?: string | null; liveTill?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getSaved-filters": { parameters: { query?: { /** @description Page number, from 1 */ page?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description The list page it belongs to */ page: string; name: string; /** @description The filters */ params: { [key: string]: unknown; }; isDefault: boolean; /** @description Date and time (ISO 8601) */ updatedAt: string; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postSaved-filters": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { page: string; name: string; params: { [key: string]: unknown; }; isDefault?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description The list page it belongs to */ page: string; name: string; /** @description The filters */ params: { [key: string]: unknown; }; isDefault: boolean; /** @description Date and time (ISO 8601) */ updatedAt: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "putSaved-filtersId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; params?: { [key: string]: unknown; }; isDefault?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description The list page it belongs to */ page: string; name: string; /** @description The filters */ params: { [key: string]: unknown; }; isDefault: boolean; /** @description Date and time (ISO 8601) */ updatedAt: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteSaved-filtersId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ ok: true; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getDashboardToday: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description Today's events with places and check-ins */ events: ({ id: string; title: string; /** @description Date and time (ISO 8601) */ startsAt: string; /** @description Date and time (ISO 8601) */ endsAt: string; sessionLabel?: string | null; places: number; checkedIn: number; } & { [key: string]: unknown; })[]; money?: ({ /** @description Rand */ today: number; todayCount: number; /** @description Rand */ week: number; } & { [key: string]: unknown; }) | null; /** @description What's waiting for you */ pending: ({ key: string; label: string; count: number; href: string; tone?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getDashboardSearch: { parameters: { query?: { /** @description Text to search for */ q?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { results: ({ /** @description event, payment, person, registration */ type: string; id: string; title: string; subtitle?: string | null; href?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getStatsStaff: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { scanStats: { totalToday?: number; myToday?: number; lastHour?: number; byStaff?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; recentScans: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getStatsSupervisor: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { scanStats: { totalToday?: number; myToday?: number; lastHour?: number; byStaff?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; recentScans: { [key: string]: unknown; }[]; paymentStats: { [key: string]: unknown; }; activeEventsCount: number; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getStatsAdmin: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { scanStats: { totalToday?: number; myToday?: number; lastHour?: number; byStaff?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; recentScans: { [key: string]: unknown; }[]; paymentStats: { [key: string]: unknown; }; activeEventsCount: number; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getStatsOverview: { parameters: { query?: { /** @description On or after (ISO date or date-time) */ from?: string; /** @description On or before (ISO date or date-time) */ to?: string; /** @description Campus id or slug (`all` for every campus) */ campus?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { funnel?: { [key: string]: unknown; } | null; activeEvents: number; registrations: { thisMonth: number; lastMonth: number; pctChange?: number | null; } & { [key: string]: unknown; }; ticketsSold: { thisMonth: number; lastMonth: number; pctChange?: number | null; } & { [key: string]: unknown; }; revenue: { thisMonth: number; lastMonth: number; pctChange?: number | null; } & { [key: string]: unknown; }; donations: { thisMonth: number; lastMonth: number; pctChange?: number | null; } & { [key: string]: unknown; }; trend: ({ date: string; /** @description Rand */ revenue: number; } & { [key: string]: unknown; })[]; topEvents: ({ eventId: string; title: string; /** @description Rand */ revenue: number; registrations: number; ticketsSold: number; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAnalyticsTrack: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The browser's analytics id */ sessionId: string; eventId: string; /** @enum {string} */ stage: "view" | "start" | "submit" | "paid"; /** @description Where they came from */ source?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Always 204, no content */ data: null; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getAnalyticsFunnel: { parameters: { query?: { /** @description These events (comma-separated ids) */ eventIds?: string; /** @description Only this event */ eventId?: string; /** @description On or after (ISO date or date-time) */ from?: string; /** @description On or before (ISO date or date-time) */ to?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Counts per stage (view, start, submit, paid), sources and devices, and per ticket */ data: { /** @description The same for each event */ perEvent: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postReportsPdf: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { title: string; subtitle?: string | null; /** @enum {string} */ kind: "table" | "layered"; /** @description kind table */ table?: { columns: string[]; rows: unknown[][]; } & { [key: string]: unknown; }; /** @description kind layered: titled sections, each with its rows */ layered?: { header?: string | null; sections: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; /** @enum {string} */ orientation?: "portrait" | "landscape"; /** @description Figures shown above the table */ stats?: { [key: string]: unknown; }[]; chart?: { [key: string]: unknown; }; note?: string | null; extraTables?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description The file */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": string; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postReportsExcel: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { title: string; subtitle?: string | null; /** @enum {string} */ kind: "table" | "layered"; /** @description kind table */ table?: { columns: string[]; rows: unknown[][]; } & { [key: string]: unknown; }; /** @description kind layered: titled sections, each with its rows */ layered?: { header?: string | null; sections: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; /** @enum {string} */ orientation?: "portrait" | "landscape"; /** @description Figures shown above the table */ stats?: { [key: string]: unknown; }[]; chart?: { [key: string]: unknown; }; note?: string | null; extraTables?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description The file */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": string; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postReportsEmail: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { title: string; subtitle?: string | null; /** @enum {string} */ kind: "table" | "layered"; /** @description kind table */ table?: { columns: string[]; rows: unknown[][]; } & { [key: string]: unknown; }; /** @description kind layered: titled sections, each with its rows */ layered?: { header?: string | null; sections: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; /** @enum {string} */ orientation?: "portrait" | "landscape"; /** @description Figures shown above the table */ stats?: { [key: string]: unknown; }[]; chart?: { [key: string]: unknown; }; note?: string | null; extraTables?: { [key: string]: unknown; }[]; subject?: string | null; /** @description Text of the email */ body?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postReportsWhatsapp: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { title: string; subtitle?: string | null; /** @enum {string} */ kind: "table" | "layered"; /** @description kind table */ table?: { columns: string[]; rows: unknown[][]; } & { [key: string]: unknown; }; /** @description kind layered: titled sections, each with its rows */ layered?: { header?: string | null; sections: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; /** @enum {string} */ orientation?: "portrait" | "landscape"; /** @description Figures shown above the table */ stats?: { [key: string]: unknown; }[]; chart?: { [key: string]: unknown; }; note?: string | null; extraTables?: { [key: string]: unknown; }[]; caption?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMePrivacy: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { news: { email: boolean; whatsapp: boolean; } & { [key: string]: unknown; }; newsAskedAt?: string | null; canWhatsApp: boolean; notificationPreference?: string | null; /** @description Every change to my news consent */ history: { [key: string]: unknown; }[]; requests: ({ id: string; /** @enum {string} */ type: "access" | "correction" | "deletion"; /** @enum {string} */ status: "open" | "completed" | "rejected" | "cancelled"; userId?: string | null; name?: string; email?: string; details?: string | null; response?: string | null; /** @description 30 days after it was made */ dueAt?: string | null; closedAt?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putMePrivacyNews: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { email?: boolean | null; whatsapp?: boolean | null; /** @description Where it was changed, for the consent log */ source?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { news: { email: boolean; whatsapp: boolean; } & { [key: string]: unknown; }; newsAskedAt?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMePrivacyExport: { parameters: { query?: { /** @description File type, e.g. `pdf` or `xlsx` */ format?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The file */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMePrivacyRequests: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @enum {string} */ type: "correction" | "deletion"; /** @description A correction: what to change */ details?: string | null; /** @description A deletion: closes the account too */ password?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { request: { id: string; /** @enum {string} */ type: "access" | "correction" | "deletion"; /** @enum {string} */ status: "open" | "completed" | "rejected" | "cancelled"; userId?: string | null; name?: string; email?: string; details?: string | null; response?: string | null; /** @description 30 days after it was made */ dueAt?: string | null; closedAt?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; }; message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMePrivacyNoticeAccept: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The version accepted */ version: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPrivacyNotice: { parameters: { query?: { /** @description A version number (default: the current one) */ version?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description 0: the built-in text */ version: number; builtIn?: boolean | null; current?: boolean | null; publishedAt?: string | null; effectiveDate?: string | null; changeSummary?: string | null; /** @description Rendered sections */ sections: { [key: string]: unknown; }[]; /** @description Every published version */ versions: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getUnsubscribeToken: { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @enum {string} */ kind: "account" | "address"; /** @description Partly hidden */ email?: string | null; hasPhone?: boolean | null; news?: { email: boolean; whatsapp: boolean; } & { [key: string]: unknown; }; /** @description kind address: the email or phone, partly hidden */ address?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postUnsubscribeToken: { parameters: { query?: never; header?: never; path: { /** @description The token from the link (it is the credential) */ token: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Default: the link's channel */ channels?: ("email" | "whatsapp")[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPrivacyRequests: { parameters: { query?: { /** @description Only this status */ status?: string; /** @description Text to search for */ search?: string; /** @description Page number, from 1 */ page?: string; /** @description How many per page */ limit?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { requests: ({ id: string; /** @enum {string} */ type: "access" | "correction" | "deletion"; /** @enum {string} */ status: "open" | "completed" | "rejected" | "cancelled"; userId?: string | null; name?: string; email?: string; details?: string | null; response?: string | null; /** @description 30 days after it was made */ dueAt?: string | null; closedAt?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; overdue?: boolean | null; /** @description Upcoming registrations that stop a deletion */ blockers?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; })[]; openCount: number; total: number; page: number; limit: number; pages: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPrivacyRequestsIdComplete: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Emailed to them; needed for a correction */ response?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { request: { id: string; /** @enum {string} */ type: "access" | "correction" | "deletion"; /** @enum {string} */ status: "open" | "completed" | "rejected" | "cancelled"; userId?: string | null; name?: string; email?: string; details?: string | null; response?: string | null; /** @description 30 days after it was made */ dueAt?: string | null; closedAt?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; }; /** @description A deletion: what was removed */ anonymised?: { [key: string]: unknown; } | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPrivacyRequestsIdReject: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The reason, emailed to them */ response: string; /** @description They withdrew it */ cancelled?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { request: { id: string; /** @enum {string} */ type: "access" | "correction" | "deletion"; /** @enum {string} */ status: "open" | "completed" | "rejected" | "cancelled"; userId?: string | null; name?: string; email?: string; details?: string | null; response?: string | null; /** @description 30 days after it was made */ dueAt?: string | null; closedAt?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPrivacyNoticeDraft: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { sections: ({ key?: string; title: string; /** @description Text; {placeholders} are filled in */ body: string; } & { [key: string]: unknown; })[]; isDraft?: boolean | null; /** @description The sections with placeholders filled in */ rendered: { [key: string]: unknown; }[]; /** @description The placeholders the text can use */ placeholders: string[]; /** @description Published versions */ versions: { [key: string]: unknown; }[]; builtIn: ({ key?: string; title: string; /** @description Text; {placeholders} are filled in */ body: string; } & { [key: string]: unknown; })[]; /** @description Changes to the built-in text not reviewed yet */ builtInUpdates: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putPrivacyNoticeDraft: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { sections: ({ key?: string; title: string; /** @description Text; {placeholders} are filled in */ body: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { sections: ({ key?: string; title: string; /** @description Text; {placeholders} are filled in */ body: string; } & { [key: string]: unknown; })[]; rendered: { [key: string]: unknown; }[]; /** @constant */ isDraft: true; /** @description Date and time (ISO 8601) */ savedAt: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deletePrivacyNoticeDraft: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPrivacyNoticePublish: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { sections?: ({ key?: string; title: string; /** @description Text; {placeholders} are filled in */ body: string; } & { [key: string]: unknown; })[]; /** @description Shown to people asked to accept it */ changeSummary: string; requiresAcceptance?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { version: number; /** @description Date and time (ISO 8601) */ publishedAt: string; requiresAcceptance: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postPrivacyNoticeBuiltin-reviewed": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { builtInUpdates: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPrivacyOperators: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ name: string; /** @description What they do for the church */ purpose: string; dataShared?: string | null; /** @description Country the data is kept in */ location?: string | null; website?: string | null; active: boolean; order: number; id: string; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Date and time (ISO 8601) */ updatedAt: string; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPrivacyOperators: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name: string; /** @description What they do for the church */ purpose: string; dataShared?: string | null; /** @description Country the data is kept in */ location?: string | null; website?: string | null; active?: boolean | null; order?: number | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { name: string; /** @description What they do for the church */ purpose: string; dataShared?: string | null; /** @description Country the data is kept in */ location?: string | null; website?: string | null; active: boolean; order: number; id: string; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Date and time (ISO 8601) */ updatedAt: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putPrivacyOperatorsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string; /** @description What they do for the church */ purpose?: string; dataShared?: string | null; /** @description Country the data is kept in */ location?: string | null; website?: string | null; active?: boolean | null; order?: number | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { name: string; /** @description What they do for the church */ purpose: string; dataShared?: string | null; /** @description Country the data is kept in */ location?: string | null; website?: string | null; active: boolean; order: number; id: string; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Date and time (ISO 8601) */ updatedAt: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deletePrivacyOperatorsId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getPrivacyConsent-log": { parameters: { query?: { /** @description Which kind */ type?: string; /** @description Page number, from 1 */ page?: string; /** @description Text to search for */ q?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description `type` news: email, channel, granted, source, ip; notice: email, version, source, ip; parental: child, event, status, signedName */ data: { total: number; pageSize: number; rows: ({ id: string; at?: string | null; name?: string | null; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getPrivacyAccess-log": { parameters: { query?: { /** @description Page number, from 1 */ page?: string; /** @description Only this action */ action?: string; /** @description `true`: only access to sensitive information */ sensitive?: string; /** @description Only things this person did */ actorId?: string; /** @description On or after (ISO date or date-time) */ from?: string; /** @description On or before (ISO date or date-time) */ to?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { total: number; pageSize: number; rows: ({ id: string; /** @description Date and time (ISO 8601) */ at: string; actor: string; actorRole?: string | null; action: string; what?: string | null; records?: number | null; eventId?: string | null; ip?: string | null; sensitive: boolean; } & { [key: string]: unknown; })[]; actions: string[]; actors: ({ id: string; name: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPrivacyReadiness: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description % */ score: number; passed: number; total: number; checks: ({ key: string; label: string; ok: boolean; detail?: string | null; href?: string | null; applies: boolean; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPrivacyRetention: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description Per kind of information: how long it is kept */ policies: { [key: string]: unknown; }; definitions: { [key: string]: unknown; }; /** @description What the rules would remove now */ preview: { [key: string]: unknown; }; lastRun?: { [key: string]: unknown; } | null; related: { medicalDays: number; backupCount: number; analyticsDays: number; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putPrivacyRetention: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Per kind of information: { enabled, months } */ policies: { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description Per kind of information: how long it is kept */ policies: { [key: string]: unknown; }; definitions: { [key: string]: unknown; }; /** @description What the rules would remove now */ preview: { [key: string]: unknown; }; lastRun?: { [key: string]: unknown; } | null; related: { medicalDays: number; backupCount: number; analyticsDays: number; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPrivacyRetentionRun: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description What was removed or anonymised */ result: { [key: string]: unknown; }; state: { /** @description Per kind of information: how long it is kept */ policies: { [key: string]: unknown; }; definitions: { [key: string]: unknown; }; /** @description What the rules would remove now */ preview: { [key: string]: unknown; }; lastRun?: { [key: string]: unknown; } | null; related: { medicalDays: number; backupCount: number; analyticsDays: number; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPrivacyBreaches: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ title: string; description: string; dataAffected: string; peopleAffected?: number | string | null; whoAffected?: string | null; consequences?: string | null; actionsTaken?: string | null; adviceToPeople?: string | null; causedBy?: string | null; status: string; /** @description Date and time (ISO 8601) */ discoveredAt: string; occurredAt?: string | null; /** @description When the Information Regulator was told */ regulatorNotifiedAt?: string | null; peopleNotifiedAt?: string | null; id: string; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Date and time (ISO 8601) */ updatedAt: string; createdBy?: ({ name: string; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPrivacyBreaches: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { title: string; description: string; dataAffected: string; peopleAffected?: number | string | null; whoAffected?: string | null; consequences?: string | null; actionsTaken?: string | null; adviceToPeople?: string | null; causedBy?: string | null; /** @description open or closed */ status?: string | null; /** @description Date and time (ISO 8601) */ discoveredAt: string; occurredAt?: string | null; /** @description When the Information Regulator was told */ regulatorNotifiedAt?: string | null; peopleNotifiedAt?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { title: string; description: string; dataAffected: string; peopleAffected?: number | string | null; whoAffected?: string | null; consequences?: string | null; actionsTaken?: string | null; adviceToPeople?: string | null; causedBy?: string | null; status: string; /** @description Date and time (ISO 8601) */ discoveredAt: string; occurredAt?: string | null; /** @description When the Information Regulator was told */ regulatorNotifiedAt?: string | null; peopleNotifiedAt?: string | null; id: string; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Date and time (ISO 8601) */ updatedAt: string; createdBy?: ({ name: string; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putPrivacyBreachesId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { title?: string; description?: string; dataAffected?: string; peopleAffected?: number | string | null; whoAffected?: string | null; consequences?: string | null; actionsTaken?: string | null; adviceToPeople?: string | null; causedBy?: string | null; /** @description open or closed */ status?: string | null; /** @description Date and time (ISO 8601) */ discoveredAt?: string; occurredAt?: string | null; /** @description When the Information Regulator was told */ regulatorNotifiedAt?: string | null; peopleNotifiedAt?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { title: string; description: string; dataAffected: string; peopleAffected?: number | string | null; whoAffected?: string | null; consequences?: string | null; actionsTaken?: string | null; adviceToPeople?: string | null; causedBy?: string | null; status: string; /** @description Date and time (ISO 8601) */ discoveredAt: string; occurredAt?: string | null; /** @description When the Information Regulator was told */ regulatorNotifiedAt?: string | null; peopleNotifiedAt?: string | null; id: string; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Date and time (ISO 8601) */ updatedAt: string; createdBy?: ({ name: string; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getAdminAudit-log": { parameters: { query?: { /** @description Page number, from 1 */ page?: string; /** @description How many per page */ limit?: string; /** @description Only things this person did */ actorId?: string; /** @description Only this action */ action?: string; /** @description admin, supervisor, staff or user */ role?: string; /** @description On or after (ISO date or date-time) */ from?: string; /** @description On or before (ISO date or date-time) */ to?: string; /** @description Text to search for */ search?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { rows: ({ id: string; action: string; actorRole?: string | null; targetType?: string | null; targetId?: string | null; metadata?: { [key: string]: unknown; } | null; ip?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; actor?: ({ id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }) | null; } & { [key: string]: unknown; })[]; total: number; page: number; limit: number; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getAdminJobs: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description on, off or timers */ mode: string; timezone: string; jobs: ({ name: string; label: string; cron?: string | null; enabled: boolean; envFlag?: string | null; nextRun?: string | null; /** @description Recent runs */ recent: { [key: string]: unknown; }[]; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAdminJobsNameRun: { parameters: { query?: never; header?: never; path: { /** @description The name */ name: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { queued: boolean; id?: string | null; /** @description When it ran straight away */ output?: unknown; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getAdminImpersonation-sessions": { parameters: { query?: { /** @description How many per page */ limit?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; reason?: string | null; startedAt?: string | null; endedAt?: string | null; expiresAt?: string | null; admin?: ({ name: string; email?: string | null; } & { [key: string]: unknown; }) | null; target?: ({ name: string; email?: string | null; } & { [key: string]: unknown; }) | null; /** @description What they did (up to 500) */ requests: ({ method: string; path: string; blocked: boolean; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAdminImpersonateUserId: { parameters: { query?: never; header?: never; path: { /** @description The person's id */ userId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Why — kept in the log */ reason: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description A read-only sign-in token */ token: string; session: { id: string; /** @description Date and time (ISO 8601) */ expiresAt: string; target: { id: string; name: string; email: string; role: string; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getMeImpersonation: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description Date and time (ISO 8601) */ expiresAt: string; target: { id?: string; name: string; email?: string | null; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }) | null; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMeImpersonationEnd: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postMeImpersonationLog: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { path: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Always 204, no content */ data: null; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getSettings: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Setting key → value: name, logo, colours, contact details, what's switched on */ data: { [key: string]: string; }; }; }; }; }; }; putSettings: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getSettingsAll: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Setting key → value; secrets masked */ data: { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postSettingsTest-smtp": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { host?: string | null; port?: number | string; secure?: boolean | string; user?: string | null; pass?: string | null; from?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getSetupNeeded: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { needsSetup: boolean; } & { [key: string]: unknown; }; }; }; }; }; }; postSetupRegister: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { adminName: string; adminEmail: string; /** @description At least 8 characters */ adminPassword: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { token: string; name: string; email: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postSetup: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Setting key → value */ settings: { [key: string]: unknown; }; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getHubStatus: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description active, grace, suspended, revoked, none… */ state: string; readOnly: boolean; daysLeft?: number | null; endsAt?: string | null; graceEndsAt?: string | null; licence?: ({ customer?: string | null; plan?: string | null; status?: string | null; licenceExpiresAt?: string | null; graceDays?: number | null; issuedAt?: string | null; validUntil?: string | null; limits: { [key: string]: unknown; }; } & { [key: string]: unknown; }) | null; connected: boolean; keyConfigured: boolean; hubUrl?: string | null; lastHeartbeatAt?: string | null; lastError?: string | null; /** @description This site's version */ version: string; latestVersion?: string | null; updateAvailable: boolean; urgentUpdate: boolean; updateSnoozed?: boolean | null; /** @description What's new in each version since this one */ releases?: { [key: string]: unknown; }[]; updateRequest?: { [key: string]: unknown; } | null; notices?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postHubConnect: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { licenceKey: string; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description active, grace, suspended, revoked, none… */ state: string; readOnly: boolean; daysLeft?: number | null; endsAt?: string | null; graceEndsAt?: string | null; licence?: ({ customer?: string | null; plan?: string | null; status?: string | null; licenceExpiresAt?: string | null; graceDays?: number | null; issuedAt?: string | null; validUntil?: string | null; limits: { [key: string]: unknown; }; } & { [key: string]: unknown; }) | null; connected: boolean; keyConfigured: boolean; hubUrl?: string | null; lastHeartbeatAt?: string | null; lastError?: string | null; /** @description This site's version */ version: string; latestVersion?: string | null; updateAvailable: boolean; urgentUpdate: boolean; updateSnoozed?: boolean | null; /** @description What's new in each version since this one */ releases?: { [key: string]: unknown; }[]; updateRequest?: { [key: string]: unknown; } | null; notices?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postHubHeartbeat: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description active, grace, suspended, revoked, none… */ state: string; readOnly: boolean; daysLeft?: number | null; endsAt?: string | null; graceEndsAt?: string | null; licence?: ({ customer?: string | null; plan?: string | null; status?: string | null; licenceExpiresAt?: string | null; graceDays?: number | null; issuedAt?: string | null; validUntil?: string | null; limits: { [key: string]: unknown; }; } & { [key: string]: unknown; }) | null; connected: boolean; keyConfigured: boolean; hubUrl?: string | null; lastHeartbeatAt?: string | null; lastError?: string | null; /** @description This site's version */ version: string; latestVersion?: string | null; updateAvailable: boolean; urgentUpdate: boolean; updateSnoozed?: boolean | null; /** @description What's new in each version since this one */ releases?: { [key: string]: unknown; }[]; updateRequest?: { [key: string]: unknown; } | null; notices?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postHubUpdate-request": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description active, grace, suspended, revoked, none… */ state: string; readOnly: boolean; daysLeft?: number | null; endsAt?: string | null; graceEndsAt?: string | null; licence?: ({ customer?: string | null; plan?: string | null; status?: string | null; licenceExpiresAt?: string | null; graceDays?: number | null; issuedAt?: string | null; validUntil?: string | null; limits: { [key: string]: unknown; }; } & { [key: string]: unknown; }) | null; connected: boolean; keyConfigured: boolean; hubUrl?: string | null; lastHeartbeatAt?: string | null; lastError?: string | null; /** @description This site's version */ version: string; latestVersion?: string | null; updateAvailable: boolean; urgentUpdate: boolean; updateSnoozed?: boolean | null; /** @description What's new in each version since this one */ releases?: { [key: string]: unknown; }[]; updateRequest?: { [key: string]: unknown; } | null; notices?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postHubUpdate-requestCancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description active, grace, suspended, revoked, none… */ state: string; readOnly: boolean; daysLeft?: number | null; endsAt?: string | null; graceEndsAt?: string | null; licence?: ({ customer?: string | null; plan?: string | null; status?: string | null; licenceExpiresAt?: string | null; graceDays?: number | null; issuedAt?: string | null; validUntil?: string | null; limits: { [key: string]: unknown; }; } & { [key: string]: unknown; }) | null; connected: boolean; keyConfigured: boolean; hubUrl?: string | null; lastHeartbeatAt?: string | null; lastError?: string | null; /** @description This site's version */ version: string; latestVersion?: string | null; updateAvailable: boolean; urgentUpdate: boolean; updateSnoozed?: boolean | null; /** @description What's new in each version since this one */ releases?: { [key: string]: unknown; }[]; updateRequest?: { [key: string]: unknown; } | null; notices?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postHubUpdate-snooze": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description false: stop putting it off */ snooze?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description active, grace, suspended, revoked, none… */ state: string; readOnly: boolean; daysLeft?: number | null; endsAt?: string | null; graceEndsAt?: string | null; licence?: ({ customer?: string | null; plan?: string | null; status?: string | null; licenceExpiresAt?: string | null; graceDays?: number | null; issuedAt?: string | null; validUntil?: string | null; limits: { [key: string]: unknown; }; } & { [key: string]: unknown; }) | null; connected: boolean; keyConfigured: boolean; hubUrl?: string | null; lastHeartbeatAt?: string | null; lastError?: string | null; /** @description This site's version */ version: string; latestVersion?: string | null; updateAvailable: boolean; urgentUpdate: boolean; updateSnoozed?: boolean | null; /** @description What's new in each version since this one */ releases?: { [key: string]: unknown; }[]; updateRequest?: { [key: string]: unknown; } | null; notices?: { [key: string]: unknown; }[]; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getHubNotices: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; /** @description info, warning, critical */ level: string; title: string; message: string; startsAt?: string | null; endsAt?: string | null; updatedAt?: string | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getOutbound-webhooks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description Every event type, with an example body */ eventTypes: { [key: string]: unknown; }[]; /** @description How long deliveries are kept */ keepDays: number; endpoints: ({ id: string; name: string; url: string; /** @description Event types it gets */ events: string[]; isActive: boolean; /** @description Its entry in the operator register */ operatorId?: string | null; lastSuccessAt?: string | null; lastFailureAt?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description Status → deliveries in the last 7 days */ lastWeek: { [key: string]: number; }; } & { [key: string]: unknown; })[]; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postOutbound-webhooks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name: string; /** @description https:// address */ url: string; events: string[]; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; url: string; /** @description Event types it gets */ events: string[]; isActive: boolean; /** @description Its entry in the operator register */ operatorId?: string | null; lastSuccessAt?: string | null; lastFailureAt?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; /** @description For checking signatures — shown only now */ secret: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postOutbound-webhook-deliveriesIdResend": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description succeeded, failed, retrying… */ status?: string | null; statusCode?: number | null; error?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "deleteOutbound-webhooksId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ ok: true; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "patchOutbound-webhooksId": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; url?: string | null; events?: string[]; isActive?: boolean | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; name: string; url: string; /** @description Event types it gets */ events: string[]; isActive: boolean; /** @description Its entry in the operator register */ operatorId?: string | null; lastSuccessAt?: string | null; lastFailureAt?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postOutbound-webhooksIdRotate-secret": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description Shown only now; the old one stops working */ secret: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "postOutbound-webhooksIdTest": { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description succeeded, failed, retrying… */ status?: string | null; statusCode?: number | null; error?: string | null; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; "getOutbound-webhooksIdDeliveries": { parameters: { query?: { /** @description Page number, from 1 */ page?: string; /** @description How many per page */ limit?: string; /** @description Only this status */ status?: string; /** @description Older than (ISO date-time), for the next page */ before?: string; }; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ id: string; eventId: string; /** @description The event type */ type: string; payload: unknown; /** @description pending, sending, retrying, succeeded, failed */ status: string; attempts: number; nextAttemptAt?: string | null; lastStatusCode?: number | null; lastError?: string | null; /** @description Date and time (ISO 8601) */ createdAt: string; deliveredAt?: string | null; } & { [key: string]: unknown; })[]; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getBackups: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: ({ filename: string; /** @description Bytes */ size: number; /** @description Date and time (ISO 8601) */ createdAt: string; } & { [key: string]: unknown; })[]; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postBackupsRun: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The backup made */ data: { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getBackupsFilenameDownload: { parameters: { query?: never; header?: never; path: { /** @description The file name */ filename: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The file */ 200: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": string; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPaymentsYocoConfig: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { secretKeyMasked: string; /** @description settings or env */ secretKeySource?: string | null; /** @description test or live */ mode?: string | null; webhookSecretMasked: string; webhookSecretSource?: string | null; webhookId: string; webhookUrl: string; configured: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putPaymentsYocoConfig: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description sk_test_… or sk_live_… */ secretKey?: string | null; /** @description whsec_… */ webhookSecret?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPaymentsYocoWebhooks: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { webhooks: ({ id: string; name?: string | null; url: string; mode?: string | null; isActive: boolean; pointsHere: boolean; } & { [key: string]: unknown; })[]; defaultUrl: string; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPaymentsYocoWebhooks: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name?: string | null; /** @description Default: this site's webhook address */ url?: string | null; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; webhook: { id: string; name?: string | null; url: string; mode?: string | null; } & { [key: string]: unknown; }; webhookSecretMasked: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; deletePaymentsYocoWebhooksId: { parameters: { query?: never; header?: never; path: { /** @description The id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; clearedSecret: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getPaymentsPayfastConfig: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { merchantId: string; merchantKey: string; passphraseMasked: string; hasPassphrase: boolean; /** @enum {string} */ mode: "sandbox" | "live"; notifyUrl: string; /** @description Why PayFast couldn't reach it */ notifyUrlProblem?: string | null; configured: boolean; } & { [key: string]: unknown; }; }; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; putPaymentsPayfastConfig: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { merchantId?: string | null; merchantKey?: string | null; /** @description At most 32 characters */ passphrase?: string | null; /** @enum {string} */ mode?: "sandbox" | "live"; } & { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postPaymentsPayfastTest: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description No body needed: send an empty object. */ requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { message: string; } & { [key: string]: unknown; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; getCheckinQrCode: { parameters: { query?: { /** @description Multi-day events: the session (default: today's) */ sessionId?: string; }; header?: never; path: { /** @description The code in the ticket's QR */ qrCode: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @enum {string} */ outcome: "found" | "transferred"; /** @description For a transferred ticket: who has it now */ message: string | null; ticket: { id: string; eventId: string; eventTitle: string | null; /** @description For section checks */ ticketOptionId: string | null; ticketName: string | null; variant: string | null; /** @description The attendee named on it, if any */ attendee: string | null; /** @description Who registered */ bookedBy: string | null; quantity: number; /** @description Still to check in (this session, on multi-day events) */ remaining: number; session: { id: string; label: string; } | null; /** @description Why no session is open for check-in now */ sessionError: string | null; /** @description not_required, given, pending, declined or missing */ consentStatus: string; } | null; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postCheckinQrCode: { parameters: { query?: never; header?: never; path: { /** @description The code in the ticket's QR */ qrCode: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Refuse tickets for any other event */ eventId?: string; /** @description Only tickets valid for this section */ sectionId?: string; /** @description Multi-day events: the session (default: today's) */ sessionId?: string; /** @description How many to check in (default: everyone left) */ people?: number; overrideConsent?: boolean; /** @description This scanner, so its own offline lock doesn't block it */ deviceId?: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @enum {string} */ outcome: "checked_in" | "already_used" | "consent_required" | "wrong_event" | "wrong_section" | "section_not_found" | "no_session" | "locked" | "transferred"; message: string; ticket: { id: string; eventId: string; eventTitle: string | null; /** @description The ticket option, e.g. "Adult" */ ticketName: string | null; /** @description People on this ticket */ quantity: number; } | null; /** @description People checked in by this request (0 unless checked_in) */ checkedIn: number; /** @description Still to check in afterwards */ remaining: number | null; session: { id: string; label: string; } | null; consentStatus: string | null; /** @description consent_required: whether you may override */ canOverride: boolean; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not signed in (UNAUTHENTICATED) */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not allowed for this role (FORBIDDEN) */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; /** @description Not found (NOT_FOUND) */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAuthSignup: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { name: string; /** Format: email */ email: string; password: string; phone?: string; /** * @description WhatsApp needs a valid South African number; otherwise email is used * @enum {string} */ notificationPreference?: "email" | "whatsapp" | "both"; newsOptIn?: boolean; /** @constant */ acceptTerms: true; }; }; }; responses: { /** @description OK */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ status: "signed_in"; /** @description Send as `Authorization: Bearer ` */ token: string; user: { id: string; name: string; email: string; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; }; /** @description Ask once whether they want News & announcements */ newsPromptPending: boolean; /** @description A privacy notice they must accept: never accepted (first) or a newer version (updated) */ noticePromptPending: false | ("first" | "updated"); /** @description With rememberDevice: send it with the next login to skip the code on this device */ deviceToken?: string; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAuthLogin: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Email address or phone number */ identifier: string; password: string; /** @description From an earlier login with rememberDevice */ deviceToken?: string; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ status: "signed_in"; /** @description Send as `Authorization: Bearer ` */ token: string; user: { id: string; name: string; email: string; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; }; /** @description Ask once whether they want News & announcements */ newsPromptPending: boolean; /** @description A privacy notice they must accept: never accepted (first) or a newer version (updated) */ noticePromptPending: false | ("first" | "updated"); /** @description With rememberDevice: send it with the next login to skip the code on this device */ deviceToken?: string; } | { /** @constant */ status: "code_required"; challengeId: string; /** @enum {string} */ method: "email" | "whatsapp"; /** @description Where the code went, partly hidden */ destination: string | null; /** @description true = this turns two-factor on (required for the role) */ enrolling: boolean; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; postAuthLoginCode: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { challengeId: string; code: string; /** @description Skip the code on this device next time (30 days) */ rememberDevice?: boolean; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @constant */ status: "signed_in"; /** @description Send as `Authorization: Bearer ` */ token: string; user: { id: string; name: string; email: string; /** @enum {string} */ role: "admin" | "supervisor" | "staff" | "user"; }; /** @description Ask once whether they want News & announcements */ newsPromptPending: boolean; /** @description A privacy notice they must accept: never accepted (first) or a newer version (updated) */ noticePromptPending: false | ("first" | "updated"); /** @description With rememberDevice: send it with the next login to skip the code on this device */ deviceToken?: string; }; }; }; }; /** @description Validation failed (VALIDATION_FAILED) */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Error"]; }; }; }; }; }