@medalsocial/sdk 1.7.0 → 1.9.0

package/openapi/medal-social.openapi.yaml

@@ -26,6 +26,11 @@ tags:
       Appointment bookings — the service catalogue, free slots, staff actions
       on a booking, and the customer-facing manage-token routes. Money is
       always integer øre.
+  - name: Portal
+    description: >-
+      Customer self-service portal — e-mail one-time-code login, then
+      session-bound access to the signed-in contact's own profile, bookings,
+      data export and erasure. Session routes carry `X-Portal-Session`.
   - name: GDPR
     description: Manage exports, consent records, and cookie consent.
   - name: Workspaces
@@ -727,6 +732,160 @@ paths:
                 $ref: "#/components/schemas/ApiResponse_BookingScheduleDayArray"
         default:
           $ref: "#/components/responses/ApiError"
+  /api/v1/bookings/persons:
+    get:
+      tags: [Bookings]
+      operationId: listContactPersons
+      summary: List a contact's persons
+      description: >-
+        Persons a contact books for — a child, a pet, an employee. No login of
+        their own. Active-only unless `include_inactive` is set.
+      parameters:
+        - name: contact_id
+          in: query
+          required: true
+          schema:
+            type: string
+        - name: include_inactive
+          in: query
+          schema:
+            type: boolean
+      responses:
+        "200":
+          description: Contact persons.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_ContactPersonArray"
+        default:
+          $ref: "#/components/responses/ApiError"
+    post:
+      tags: [Bookings]
+      operationId: createContactPerson
+      summary: Add a person under a contact
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateContactPersonInput"
+      responses:
+        "201":
+          description: Created person.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_ContactPerson"
+        default:
+          $ref: "#/components/responses/ApiError"
+  /api/v1/bookings/relations:
+    get:
+      tags: [Bookings]
+      operationId: listContactRelations
+      summary: List a contact's relations
+      description: Directional relations a contact holds, split into outgoing and incoming.
+      parameters:
+        - name: contact_id
+          in: query
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Outgoing and incoming relations.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_ContactRelations"
+        default:
+          $ref: "#/components/responses/ApiError"
+    post:
+      tags: [Bookings]
+      operationId: createContactRelation
+      summary: Create a relation from one contact to another
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateContactRelationInput"
+      responses:
+        "201":
+          description: Created relation id.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_CreateContactRelationResult"
+        default:
+          $ref: "#/components/responses/ApiError"
+  /api/v1/bookings/events:
+    get:
+      tags: [Bookings]
+      operationId: listBookingEvents
+      summary: List arrangementer in a date range
+      parameters:
+        - name: from
+          in: query
+          required: true
+          description: Start of the window, `yyyy-mm-dd`, inclusive.
+          schema:
+            type: string
+            format: date
+        - name: to
+          in: query
+          required: true
+          description: End of the window, `yyyy-mm-dd`, inclusive.
+          schema:
+            type: string
+            format: date
+        - name: status
+          in: query
+          schema:
+            $ref: "#/components/schemas/BookingEventStatus"
+      responses:
+        "200":
+          description: Arrangementer in the window.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_BookingEventArray"
+        default:
+          $ref: "#/components/responses/ApiError"
+    post:
+      tags: [Bookings]
+      operationId: createBookingEvent
+      summary: Create an arrangement from a template
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateBookingEventInput"
+      responses:
+        "201":
+          description: Created arrangement.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_BookingEvent"
+        default:
+          $ref: "#/components/responses/ApiError"
+  /api/v1/bookings/events/{id}:
+    parameters:
+      - $ref: "#/components/parameters/Id"
+    get:
+      tags: [Bookings]
+      operationId: getBookingEvent
+      summary: Get an arrangement
+      responses:
+        "200":
+          description: Arrangement.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_BookingEvent"
+        default:
+          $ref: "#/components/responses/ApiError"
   /api/v1/bookings/{id}:
     parameters:
       - $ref: "#/components/parameters/Id"
@@ -898,6 +1057,188 @@ paths:
                 $ref: "#/components/schemas/ApiResponse_BookingRescheduleResult"
         default:
           $ref: "#/components/responses/ApiError"
+  /api/v1/portal/login/start:
+    post:
+      tags: [Portal]
+      operationId: startPortalLogin
+      summary: E-mail a one-time login code
+      description: >-
+        Always answers 202 `{ status: "sent" }`, whether or not the address
+        belongs to a contact — enumeration-safe by design. Rate-limited per
+        address and per caller (`429 RATE_LIMITED`). Not idempotency-keyed.
+        Errors: `400 VALIDATION_ERROR`, `403 FORBIDDEN` (key lacks
+        `write:portal`), `429 RATE_LIMITED`.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PortalLoginStartInput"
+      responses:
+        "202":
+          description: Code queued (or silently not, for an unknown address).
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_PortalLoginStartResult"
+        default:
+          $ref: "#/components/responses/ApiError"
+  /api/v1/portal/login/verify:
+    post:
+      tags: [Portal]
+      operationId: verifyPortalLogin
+      summary: Exchange the e-mailed code for a session
+      description: >-
+        A wrong, burned or expired code all answer `401 PORTAL_CODE_INVALID` —
+        the three are not distinguished, so the response is not an oracle for
+        which codes exist. The returned `session_token` is a bearer credential
+        for ONE contact: keep it in an HttpOnly cookie on the site's server and
+        never hand it to the browser. Not idempotency-keyed. Errors:
+        `400 VALIDATION_ERROR`, `401 PORTAL_CODE_INVALID`, `403 FORBIDDEN`,
+        `429 RATE_LIMITED`.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PortalVerifyInput"
+      responses:
+        "200":
+          description: The new session.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_PortalSession"
+        default:
+          $ref: "#/components/responses/ApiError"
+  /api/v1/portal/logout:
+    parameters:
+      - $ref: "#/components/parameters/PortalSession"
+    post:
+      tags: [Portal]
+      operationId: logoutPortal
+      summary: Revoke the session
+      description: >-
+        Revoking twice reaches the same state — the second call answers
+        `401 PORTAL_SESSION_INVALID`. Not idempotency-keyed. Errors:
+        `401 PORTAL_SESSION_REQUIRED` (header missing),
+        `401 PORTAL_SESSION_INVALID` (unknown, expired or revoked),
+        `403 FORBIDDEN`, `429 RATE_LIMITED`.
+      responses:
+        "204":
+          description: Session revoked.
+        default:
+          $ref: "#/components/responses/ApiError"
+  /api/v1/portal/me:
+    parameters:
+      - $ref: "#/components/parameters/PortalSession"
+    get:
+      tags: [Portal]
+      operationId: getPortalProfile
+      summary: The signed-in contact's profile
+      description: >-
+        Errors: `401 PORTAL_SESSION_REQUIRED`, `401 PORTAL_SESSION_INVALID`,
+        `403 FORBIDDEN` (key lacks `read:portal`), `429 RATE_LIMITED`.
+      responses:
+        "200":
+          description: Profile.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_PortalProfile"
+        default:
+          $ref: "#/components/responses/ApiError"
+    patch:
+      tags: [Portal]
+      operationId: updatePortalProfile
+      summary: Update the signed-in contact's profile
+      description: >-
+        Only the supplied fields change. `phone: null` clears the number,
+        `family` replaces the whole list, and `marketing_consent` records a
+        `marketing_email` consent decision with source `portal`. Answers the
+        profile as it is after the change. Errors: `400 VALIDATION_ERROR`,
+        `401 PORTAL_SESSION_REQUIRED`, `401 PORTAL_SESSION_INVALID`,
+        `403 FORBIDDEN` (key lacks `write:portal`), `429 RATE_LIMITED`.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PortalProfilePatch"
+      responses:
+        "200":
+          description: Updated profile.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_PortalProfile"
+        default:
+          $ref: "#/components/responses/ApiError"
+  /api/v1/portal/me/bookings:
+    parameters:
+      - $ref: "#/components/parameters/PortalSession"
+    get:
+      tags: [Portal]
+      operationId: listPortalBookings
+      summary: The signed-in contact's bookings
+      description: >-
+        Split into `upcoming` and `past`. An upcoming booking still inside the
+        workspace's policy windows carries `manage_token` and
+        `can_manage: true`; the token opens the site's manage page. Errors:
+        `401 PORTAL_SESSION_REQUIRED`, `401 PORTAL_SESSION_INVALID`,
+        `403 FORBIDDEN`, `429 RATE_LIMITED`.
+      responses:
+        "200":
+          description: Bookings.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_PortalBookings"
+        default:
+          $ref: "#/components/responses/ApiError"
+  /api/v1/portal/me/export:
+    parameters:
+      - $ref: "#/components/parameters/PortalSession"
+    post:
+      tags: [Portal]
+      operationId: exportPortalData
+      summary: Export everything held about the signed-in contact
+      description: >-
+        A synchronous GDPR Art. 15 export of the contact's profile, family,
+        consents and bookings, as one JSON document. Unlike `GET
+        /api/v1/portal/me`, `contact.persons` here includes inactive persons
+        so the export is a complete dump. `relations` lists every relation
+        the contact is a party to, exposing only the counterpart's display
+        name. Read-only, so not idempotency-keyed. Errors: `401
+        PORTAL_SESSION_REQUIRED`, `401 PORTAL_SESSION_INVALID`, `403
+        FORBIDDEN`, `429 RATE_LIMITED`.
+      responses:
+        "200":
+          description: The export.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApiResponse_PortalExport"
+        default:
+          $ref: "#/components/responses/ApiError"
+  /api/v1/portal/me/delete:
+    parameters:
+      - $ref: "#/components/parameters/PortalSession"
+    post:
+      tags: [Portal]
+      operationId: deletePortalAccount
+      summary: Erase the signed-in contact
+      description: >-
+        GDPR Art. 17 erasure. The session is revoked as part of the deletion,
+        so a retry answers `401 PORTAL_SESSION_INVALID` rather than deleting
+        anything else. Not idempotency-keyed. Errors:
+        `401 PORTAL_SESSION_REQUIRED`, `401 PORTAL_SESSION_INVALID`,
+        `403 FORBIDDEN` (key lacks `write:portal`), `429 RATE_LIMITED`.
+      responses:
+        "204":
+          description: Contact erased and session revoked.
+        default:
+          $ref: "#/components/responses/ApiError"
   /api/v1/gdpr/export:
     post:
       tags: [GDPR]
@@ -1541,6 +1882,18 @@ components:
         Possession of it authorizes the customer's own cancel or reschedule.
       schema:
         type: string
+    PortalSession:
+      name: X-Portal-Session
+      in: header
+      required: true
+      description: >-
+        The `session_token` returned by `verifyPortalLogin`. A bearer
+        credential for ONE contact — the site's server keeps it in an HttpOnly
+        cookie and forwards it here. Missing answers
+        `401 PORTAL_SESSION_REQUIRED`; unknown, expired or revoked answers
+        `401 PORTAL_SESSION_INVALID`.
+      schema:
+        type: string
     Cursor:
       name: cursor
       in: query
@@ -2449,6 +2802,9 @@ components:
         - end_ts
         - booked_for_name
         - booked_for_birth_year
+        - booked_for_person_id
+        - event_id
+        - event_order
         - party_sequence_id
         - status
         - cancelled_by
@@ -2481,6 +2837,15 @@ components:
         booked_for_birth_year:
           description: A birth year, not a birthdate — the age bracket is all that is stored.
           type: [integer, "null"]
+        booked_for_person_id:
+          description: The ContactPerson this booking was made for, if any.
+          type: [string, "null"]
+        event_id:
+          description: The BookingEvent this booking is a registration for, if any.
+          type: [string, "null"]
+        event_order:
+          description: Position of this booking within its event's registrations, if any.
+          type: [integer, "null"]
         party_sequence_id:
           description: Shared by every booking created in the same party request.
           type: [string, "null"]
@@ -2685,6 +3050,9 @@ components:
           type: integer
           minimum: 1900
           maximum: 2200
+        booked_for_person_id:
+          description: Book this line on behalf of a ContactPerson rather than the contact.
+          type: string
     CreateBookingInput:
       type: object
       required: [items, contact]
@@ -3615,6 +3983,16 @@ components:
       $ref: "#/components/schemas/Envelope_BookingRescheduleResult"
     ApiResponse_ManageSummary:
       $ref: "#/components/schemas/Envelope_ManageSummary"
+    ApiResponse_PortalLoginStartResult:
+      $ref: "#/components/schemas/Envelope_PortalLoginStartResult"
+    ApiResponse_PortalSession:
+      $ref: "#/components/schemas/Envelope_PortalSession"
+    ApiResponse_PortalProfile:
+      $ref: "#/components/schemas/Envelope_PortalProfile"
+    ApiResponse_PortalBookings:
+      $ref: "#/components/schemas/Envelope_PortalBookings"
+    ApiResponse_PortalExport:
+      $ref: "#/components/schemas/Envelope_PortalExport"
     ApiResponse_GdprExportRequest:
       $ref: "#/components/schemas/Envelope_GdprExportRequest"
     ApiResponse_GdprExportArray:
@@ -3946,64 +4324,377 @@ components:
       properties:
         data:
           $ref: "#/components/schemas/ManageSummary"
-    ScanCreateInput:
+    PortalLoginStartInput:
       type: object
-      description: Provide exactly one of `url`, `orgnr`, or `name`.
-      oneOf:
-        - required: [url]
-          not:
-            anyOf: [{ required: [orgnr] }, { required: [name] }]
-        - required: [orgnr]
-          not:
-            anyOf: [{ required: [url] }, { required: [name] }]
-        - required: [name]
-          not:
-            anyOf: [{ required: [url] }, { required: [orgnr] }]
+      required: [email]
       properties:
-        url:
-          type: string
-          minLength: 4
-          maxLength: 500
-        orgnr:
+        email:
           type: string
-          pattern: "^\\d{9}$"
-        name:
+          format: email
+          description: The address the code is sent to.
+        locale:
           type: string
-          minLength: 2
-          maxLength: 120
-    ScanCreateResult:
+          description: Locale for the e-mail (e.g. `nb`, `en`); the workspace default when omitted.
+    PortalLoginStartResult:
+      description: >-
+        Always `sent`, whether or not the address is a known contact — the
+        route is enumeration-safe by design.
       type: object
-      required: [id, status]
+      required: [status]
       properties:
-        id:
-          type: string
         status:
           type: string
-        message:
-          type: string
-    ScanCompany:
+          const: sent
+    PortalVerifyInput:
       type: object
-      required: [orgnr, name, org_form, industry, city, website]
+      required: [email, code]
       properties:
-        orgnr:
+        email:
           type: string
-        name:
+          format: email
+        code:
           type: string
-        org_form:
-          type: [string, "null"]
-        industry:
-          type: [string, "null"]
-        city:
-          type: [string, "null"]
-        website:
-          type: [string, "null"]
-    ScanJob:
+          description: The one-time code from the e-mail.
+    PortalContactSummary:
       type: object
-      required: [id, status, input, resolved, result, error, created_at, finished_at]
+      required: [contact_id, first_name]
       properties:
-        id:
+        contact_id:
           type: string
-        status:
+        first_name:
+          type: [string, "null"]
+    PortalSession:
+      description: >-
+        A portal session. `session_token` is a bearer credential for ONE
+        contact — keep it in an HttpOnly cookie on the site's server and never
+        hand it to the browser.
+      type: object
+      required: [session_token, expires_at, contact]
+      properties:
+        session_token:
+          type: string
+        expires_at:
+          type: integer
+          description: Unix timestamp in milliseconds.
+        contact:
+          $ref: "#/components/schemas/PortalContactSummary"
+    PortalFamilyMember:
+      type: object
+      required: [name, birth_year]
+      properties:
+        name:
+          type: string
+        birth_year:
+          type: integer
+    PortalPerson:
+      description: >-
+        A person the contact books for — a child, a pet — with no login of
+        its own.
+      type: object
+      required:
+        [person_id, name, birth_year, relation_type, relation_label, notes, active]
+      properties:
+        person_id:
+          type: string
+        name:
+          type: string
+        birth_year:
+          type: [integer, "null"]
+        relation_type:
+          $ref: "#/components/schemas/RelationType"
+        relation_label:
+          type: [string, "null"]
+        notes:
+          type: [string, "null"]
+        active:
+          type: boolean
+          description: >-
+            False for a person the customer removed or that was promoted to
+            its own contact; `me` returns active persons only, the export
+            returns all.
+    PortalLabels:
+      description: The workspace's own words for the person concept, e.g. `"Barn"`.
+      type: object
+      required: [person, persons]
+      properties:
+        person:
+          type: string
+        persons:
+          type: string
+    PortalProfile:
+      type: object
+      required:
+        - contact_id
+        - email
+        - first_name
+        - last_name
+        - phone
+        - family
+        - persons
+        - labels
+        - marketing_consent
+        - created_at
+      properties:
+        contact_id:
+          type: string
+        email:
+          type: string
+        first_name:
+          type: [string, "null"]
+        last_name:
+          type: [string, "null"]
+        phone:
+          type: [string, "null"]
+        family:
+          type: array
+          items:
+            $ref: "#/components/schemas/PortalFamilyMember"
+        persons:
+          type: array
+          items:
+            $ref: "#/components/schemas/PortalPerson"
+        labels:
+          $ref: "#/components/schemas/PortalLabels"
+        marketing_consent:
+          type: boolean
+        created_at:
+          type: integer
+          description: Unix timestamp in milliseconds.
+    PortalProfilePatch:
+      description: Only the supplied fields change.
+      type: object
+      properties:
+        first_name:
+          type: string
+        last_name:
+          type: string
+        phone:
+          type: [string, "null"]
+          description: "`null` clears the number."
+        family:
+          type: array
+          description: Replaces the whole list.
+          items:
+            $ref: "#/components/schemas/PortalFamilyMember"
+        marketing_consent:
+          type: boolean
+          description: Records a `marketing_email` consent change with source `portal`.
+    PortalBooking:
+      type: object
+      required:
+        - booking_id
+        - status
+        - start_ts
+        - end_ts
+        - service_id
+        - service_name
+        - resource_id
+        - resource_name
+        - booked_for_name
+        - amount_ore
+        - notes
+        - manage_token
+        - can_manage
+      properties:
+        booking_id:
+          type: string
+        status:
+          $ref: "#/components/schemas/BookingStatus"
+        start_ts:
+          type: integer
+          description: Unix timestamp in milliseconds.
+        end_ts:
+          type: integer
+          description: Unix timestamp in milliseconds.
+        service_id:
+          type: [string, "null"]
+        service_name:
+          type: [string, "null"]
+        resource_id:
+          type: [string, "null"]
+        resource_name:
+          type: [string, "null"]
+        booked_for_name:
+          type: [string, "null"]
+        amount_ore:
+          type: [integer, "null"]
+          description: Integer øre, or `null` when the service has no price.
+        notes:
+          type: [string, "null"]
+        manage_token:
+          type: [string, "null"]
+          description: >-
+            Present only while the booking is upcoming and manageable; opens
+            the site's manage page.
+        can_manage:
+          type: boolean
+    PortalBookings:
+      type: object
+      required: [upcoming, past]
+      properties:
+        upcoming:
+          type: array
+          items:
+            $ref: "#/components/schemas/PortalBooking"
+        past:
+          type: array
+          items:
+            $ref: "#/components/schemas/PortalBooking"
+    PortalConsentRecord:
+      type: object
+      required: [consent_type, granted, granted_at, revoked_at, source]
+      properties:
+        consent_type:
+          type: string
+        granted:
+          type: boolean
+        granted_at:
+          type: [integer, "null"]
+          description: Unix timestamp in milliseconds, or `null`.
+        revoked_at:
+          type: [integer, "null"]
+          description: Unix timestamp in milliseconds, or `null`.
+        source:
+          type: string
+    PortalExportRelation:
+      description: A relation the exporting contact is a party to; only the counterpart's display name is exposed.
+      type: object
+      required:
+        - direction
+        - type
+        - custom_label
+        - since
+        - note
+        - counterpart_name
+      properties:
+        direction:
+          type: string
+          enum: [outgoing, incoming]
+        type:
+          $ref: "#/components/schemas/RelationType"
+        custom_label:
+          type: [string, "null"]
+        since:
+          type: [integer, "null"]
+          description: Unix timestamp in milliseconds.
+        note:
+          type: [string, "null"]
+        counterpart_name:
+          type: string
+    PortalExport:
+      description: Everything the workspace holds about the signed-in contact (GDPR Art. 15).
+      type: object
+      required: [exported_at, contact, family, consents, bookings, relations]
+      properties:
+        exported_at:
+          type: integer
+          description: Unix timestamp in milliseconds.
+        contact:
+          $ref: "#/components/schemas/PortalProfile"
+        family:
+          type: array
+          items:
+            $ref: "#/components/schemas/PortalFamilyMember"
+        consents:
+          type: array
+          items:
+            $ref: "#/components/schemas/PortalConsentRecord"
+        bookings:
+          type: array
+          items:
+            $ref: "#/components/schemas/PortalBooking"
+        relations:
+          type: array
+          items:
+            $ref: "#/components/schemas/PortalExportRelation"
+    Envelope_PortalLoginStartResult:
+      type: object
+      required: [data]
+      properties:
+        data:
+          $ref: "#/components/schemas/PortalLoginStartResult"
+    Envelope_PortalSession:
+      type: object
+      required: [data]
+      properties:
+        data:
+          $ref: "#/components/schemas/PortalSession"
+    Envelope_PortalProfile:
+      type: object
+      required: [data]
+      properties:
+        data:
+          $ref: "#/components/schemas/PortalProfile"
+    Envelope_PortalBookings:
+      type: object
+      required: [data]
+      properties:
+        data:
+          $ref: "#/components/schemas/PortalBookings"
+    Envelope_PortalExport:
+      type: object
+      required: [data]
+      properties:
+        data:
+          $ref: "#/components/schemas/PortalExport"
+    ScanCreateInput:
+      type: object
+      description: Provide exactly one of `url`, `orgnr`, or `name`.
+      oneOf:
+        - required: [url]
+          not:
+            anyOf: [{ required: [orgnr] }, { required: [name] }]
+        - required: [orgnr]
+          not:
+            anyOf: [{ required: [url] }, { required: [name] }]
+        - required: [name]
+          not:
+            anyOf: [{ required: [url] }, { required: [orgnr] }]
+      properties:
+        url:
+          type: string
+          minLength: 4
+          maxLength: 500
+        orgnr:
+          type: string
+          pattern: "^\\d{9}$"
+        name:
+          type: string
+          minLength: 2
+          maxLength: 120
+    ScanCreateResult:
+      type: object
+      required: [id, status]
+      properties:
+        id:
+          type: string
+        status:
+          type: string
+        message:
+          type: string
+    ScanCompany:
+      type: object
+      required: [orgnr, name, org_form, industry, city, website]
+      properties:
+        orgnr:
+          type: string
+        name:
+          type: string
+        org_form:
+          type: [string, "null"]
+        industry:
+          type: [string, "null"]
+        city:
+          type: [string, "null"]
+        website:
+          type: [string, "null"]
+    ScanJob:
+      type: object
+      required: [id, status, input, resolved, result, error, created_at, finished_at]
+      properties:
+        id:
+          type: string
+        status:
           type: string
           description: pending | running | done | failed
         input:
@@ -4297,3 +4988,293 @@ components:
       properties:
         data:
           $ref: "#/components/schemas/ChannelConnectionDisconnectResult"
+    RelationType:
+      description: How a person or a relation relates to a contact.
+      type: string
+      enum: [guardian, owner, employer, caregiver, partner, custom]
+    ContactPerson:
+      description: >-
+        A person a contact books for — a child, a pet, an employee. No login
+        of their own.
+      type: object
+      required:
+        - person_id
+        - contact_id
+        - name
+        - birth_year
+        - relation_type
+        - relation_label
+        - notes
+        - active
+        - promoted_to_contact_id
+        - created_at
+        - updated_at
+      properties:
+        person_id:
+          type: string
+        contact_id:
+          type: string
+        name:
+          type: string
+        birth_year:
+          type: [integer, "null"]
+        relation_type:
+          $ref: "#/components/schemas/RelationType"
+        relation_label:
+          type: [string, "null"]
+        notes:
+          type: [string, "null"]
+        active:
+          type: boolean
+        promoted_to_contact_id:
+          type: [string, "null"]
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+    CreateContactPersonInput:
+      type: object
+      required: [contact_id, name, relation_type]
+      properties:
+        contact_id:
+          type: string
+        name:
+          type: string
+        birth_year:
+          type: integer
+        relation_type:
+          $ref: "#/components/schemas/RelationType"
+        relation_label:
+          type: string
+        notes:
+          type: string
+    ContactRelation:
+      description: One directional relation between two contacts.
+      type: object
+      required:
+        - relation_id
+        - from_contact_id
+        - to_contact_id
+        - type
+        - custom_label
+        - since
+        - note
+        - counterpart_name
+        - created_at
+      properties:
+        relation_id:
+          type: string
+        from_contact_id:
+          type: string
+        to_contact_id:
+          type: string
+        type:
+          $ref: "#/components/schemas/RelationType"
+        custom_label:
+          type: [string, "null"]
+        since:
+          type: [integer, "null"]
+          description: Unix timestamp in milliseconds.
+        note:
+          type: [string, "null"]
+        counterpart_name:
+          type: string
+          description: Empty string when the counterpart contact no longer exists.
+        created_at:
+          type: string
+          format: date-time
+    ContactRelations:
+      description: Relations a contact holds, split by direction.
+      type: object
+      required: [outgoing, incoming]
+      properties:
+        outgoing:
+          type: array
+          items:
+            $ref: "#/components/schemas/ContactRelation"
+        incoming:
+          type: array
+          items:
+            $ref: "#/components/schemas/ContactRelation"
+    CreateContactRelationInput:
+      type: object
+      required: [from_contact_id, to_contact_id, type]
+      properties:
+        from_contact_id:
+          type: string
+        to_contact_id:
+          type: string
+        type:
+          $ref: "#/components/schemas/RelationType"
+        custom_label:
+          type: string
+        since:
+          type: integer
+          description: Unix timestamp in milliseconds.
+        note:
+          type: string
+    CreateContactRelationResult:
+      type: object
+      required: [relation_id]
+      properties:
+        relation_id:
+          type: string
+    BookingEventStatus:
+      type: string
+      enum: [draft, open, closed, completed, cancelled]
+    BookingEventTemplateKey:
+      type: string
+      enum: [kindergarten_visit, company_day, class, open_day, custom]
+    BookingEvent:
+      description: An arrangement — a scheduled group session bookings register against.
+      type: object
+      required:
+        - event_id
+        - template_id
+        - host_id
+        - date
+        - window_start_minute
+        - window_end_minute
+        - place
+        - capacity
+        - minimum
+        - registered_count
+        - service_ids
+        - resource_ids
+        - price_override_ore
+        - status
+        - registration_closes_at
+        - slug
+        - created_at
+        - updated_at
+      properties:
+        event_id:
+          type: string
+        template_id:
+          type: string
+        host_id:
+          type: [string, "null"]
+        date:
+          description: yyyy-mm-dd in the workspace time zone.
+          type: string
+          format: date
+        window_start_minute:
+          type: integer
+        window_end_minute:
+          type: integer
+        place:
+          type: string
+          enum: [at_host, in_house]
+        capacity:
+          type: integer
+        minimum:
+          type: integer
+        registered_count:
+          type: integer
+        service_ids:
+          type: array
+          items:
+            type: string
+        resource_ids:
+          type: array
+          items:
+            type: string
+        price_override_ore:
+          type: [integer, "null"]
+        status:
+          $ref: "#/components/schemas/BookingEventStatus"
+        registration_closes_at:
+          type: string
+          format: date-time
+        slug:
+          type: string
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+    CreateBookingEventInput:
+      type: object
+      required: [template_key, date, window_start_minute, place, service_ids, resource_ids]
+      properties:
+        template_key:
+          $ref: "#/components/schemas/BookingEventTemplateKey"
+        host_id:
+          type: string
+        date:
+          type: string
+          format: date
+        window_start_minute:
+          type: integer
+        window_end_minute:
+          type: integer
+        place:
+          type: string
+          enum: [at_host, in_house]
+        capacity:
+          type: integer
+        minimum:
+          type: integer
+        service_ids:
+          type: array
+          items:
+            type: string
+        resource_ids:
+          type: array
+          items:
+            type: string
+    ApiResponse_ContactPersonArray:
+      $ref: "#/components/schemas/Envelope_ContactPersonArray"
+    ApiResponse_ContactPerson:
+      $ref: "#/components/schemas/Envelope_ContactPerson"
+    ApiResponse_ContactRelations:
+      $ref: "#/components/schemas/Envelope_ContactRelations"
+    ApiResponse_CreateContactRelationResult:
+      $ref: "#/components/schemas/Envelope_CreateContactRelationResult"
+    ApiResponse_BookingEventArray:
+      $ref: "#/components/schemas/Envelope_BookingEventArray"
+    ApiResponse_BookingEvent:
+      $ref: "#/components/schemas/Envelope_BookingEvent"
+    Envelope_ContactPersonArray:
+      type: object
+      required: [data]
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/ContactPerson"
+    Envelope_ContactPerson:
+      type: object
+      required: [data]
+      properties:
+        data:
+          $ref: "#/components/schemas/ContactPerson"
+    Envelope_ContactRelations:
+      type: object
+      required: [data]
+      properties:
+        data:
+          $ref: "#/components/schemas/ContactRelations"
+    Envelope_CreateContactRelationResult:
+      type: object
+      required: [data]
+      properties:
+        data:
+          $ref: "#/components/schemas/CreateContactRelationResult"
+    Envelope_BookingEventArray:
+      type: object
+      required: [data]
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/BookingEvent"
+    Envelope_BookingEvent:
+      type: object
+      required: [data]
+      properties:
+        data:
+          $ref: "#/components/schemas/BookingEvent"