@medalsocial/sdk 1.8.0 → 1.9.0

package/dist/src/openapi.generated.d.ts

@@ -414,6 +414,85 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/bookings/persons": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 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.
+         */
+        get: operations["listContactPersons"];
+        put?: never;
+        /** Add a person under a contact */
+        post: operations["createContactPerson"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/bookings/relations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List a contact's relations
+         * @description Directional relations a contact holds, split into outgoing and incoming.
+         */
+        get: operations["listContactRelations"];
+        put?: never;
+        /** Create a relation from one contact to another */
+        post: operations["createContactRelation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/bookings/events": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List arrangementer in a date range */
+        get: operations["listBookingEvents"];
+        put?: never;
+        /** Create an arrangement from a template */
+        post: operations["createBookingEvent"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/bookings/events/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["Id"];
+            };
+            cookie?: never;
+        };
+        /** Get an arrangement */
+        get: operations["getBookingEvent"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/bookings/{id}": {
         parameters: {
             query?: never;
@@ -690,7 +769,7 @@ interface paths {
         put?: never;
         /**
          * 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. Read-only, so not idempotency-keyed. Errors: `401 PORTAL_SESSION_REQUIRED`, `401 PORTAL_SESSION_INVALID`, `403 FORBIDDEN`, `429 RATE_LIMITED`.
+         * @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`.
          */
         post: operations["exportPortalData"];
         delete?: never;
@@ -1603,6 +1682,12 @@ interface components {
             booked_for_name: string | null;
             /** @description A birth year, not a birthdate — the age bracket is all that is stored. */
             booked_for_birth_year: number | null;
+            /** @description The ContactPerson this booking was made for, if any. */
+            booked_for_person_id: string | null;
+            /** @description The BookingEvent this booking is a registration for, if any. */
+            event_id: string | null;
+            /** @description Position of this booking within its event's registrations, if any. */
+            event_order: number | null;
             /** @description Shared by every booking created in the same party request. */
             party_sequence_id: string | null;
             status: components["schemas"]["BookingStatus"];
@@ -1698,6 +1783,8 @@ interface components {
             start_ts: components["schemas"]["BookingTimestampInput"];
             booked_for_name?: string;
             booked_for_birth_year?: number;
+            /** @description Book this line on behalf of a ContactPerson rather than the contact. */
+            booked_for_person_id?: string;
         };
         CreateBookingInput: {
             /** @description A PARTY — one request books a whole family in one all-or-nothing transaction. */
@@ -2312,6 +2399,22 @@ interface components {
             name: string;
             birth_year: number;
         };
+        /** @description A person the contact books for — a child, a pet — with no login of its own. */
+        PortalPerson: {
+            person_id: string;
+            name: string;
+            birth_year: number | null;
+            relation_type: components["schemas"]["RelationType"];
+            relation_label: string | null;
+            notes: string | null;
+            /** @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. */
+            active: boolean;
+        };
+        /** @description The workspace's own words for the person concept, e.g. `"Barn"`. */
+        PortalLabels: {
+            person: string;
+            persons: string;
+        };
         PortalProfile: {
             contact_id: string;
             email: string;
@@ -2319,6 +2422,8 @@ interface components {
             last_name: string | null;
             phone: string | null;
             family: components["schemas"]["PortalFamilyMember"][];
+            persons: components["schemas"]["PortalPerson"][];
+            labels: components["schemas"]["PortalLabels"];
             marketing_consent: boolean;
             /** @description Unix timestamp in milliseconds. */
             created_at: number;
@@ -2366,6 +2471,17 @@ interface components {
             revoked_at: number | null;
             source: string;
         };
+        /** @description A relation the exporting contact is a party to; only the counterpart's display name is exposed. */
+        PortalExportRelation: {
+            /** @enum {string} */
+            direction: "outgoing" | "incoming";
+            type: components["schemas"]["RelationType"];
+            custom_label: string | null;
+            /** @description Unix timestamp in milliseconds. */
+            since: number | null;
+            note: string | null;
+            counterpart_name: string;
+        };
         /** @description Everything the workspace holds about the signed-in contact (GDPR Art. 15). */
         PortalExport: {
             /** @description Unix timestamp in milliseconds. */
@@ -2374,6 +2490,7 @@ interface components {
             family: components["schemas"]["PortalFamilyMember"][];
             consents: components["schemas"]["PortalConsentRecord"][];
             bookings: components["schemas"]["PortalBooking"][];
+            relations: components["schemas"]["PortalExportRelation"][];
         };
         Envelope_PortalLoginStartResult: {
             data: components["schemas"]["PortalLoginStartResult"];
@@ -2554,6 +2671,138 @@ interface components {
         Envelope_ChannelConnectionDisconnectResult: {
             data: components["schemas"]["ChannelConnectionDisconnectResult"];
         };
+        /**
+         * @description How a person or a relation relates to a contact.
+         * @enum {string}
+         */
+        RelationType: "guardian" | "owner" | "employer" | "caregiver" | "partner" | "custom";
+        /** @description A person a contact books for — a child, a pet, an employee. No login of their own. */
+        ContactPerson: {
+            person_id: string;
+            contact_id: string;
+            name: string;
+            birth_year: number | null;
+            relation_type: components["schemas"]["RelationType"];
+            relation_label: string | null;
+            notes: string | null;
+            active: boolean;
+            promoted_to_contact_id: string | null;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: date-time */
+            updated_at: string;
+        };
+        CreateContactPersonInput: {
+            contact_id: string;
+            name: string;
+            birth_year?: number;
+            relation_type: components["schemas"]["RelationType"];
+            relation_label?: string;
+            notes?: string;
+        };
+        /** @description One directional relation between two contacts. */
+        ContactRelation: {
+            relation_id: string;
+            from_contact_id: string;
+            to_contact_id: string;
+            type: components["schemas"]["RelationType"];
+            custom_label: string | null;
+            /** @description Unix timestamp in milliseconds. */
+            since: number | null;
+            note: string | null;
+            /** @description Empty string when the counterpart contact no longer exists. */
+            counterpart_name: string;
+            /** Format: date-time */
+            created_at: string;
+        };
+        /** @description Relations a contact holds, split by direction. */
+        ContactRelations: {
+            outgoing: components["schemas"]["ContactRelation"][];
+            incoming: components["schemas"]["ContactRelation"][];
+        };
+        CreateContactRelationInput: {
+            from_contact_id: string;
+            to_contact_id: string;
+            type: components["schemas"]["RelationType"];
+            custom_label?: string;
+            /** @description Unix timestamp in milliseconds. */
+            since?: number;
+            note?: string;
+        };
+        CreateContactRelationResult: {
+            relation_id: string;
+        };
+        /** @enum {string} */
+        BookingEventStatus: "draft" | "open" | "closed" | "completed" | "cancelled";
+        /** @enum {string} */
+        BookingEventTemplateKey: "kindergarten_visit" | "company_day" | "class" | "open_day" | "custom";
+        /** @description An arrangement — a scheduled group session bookings register against. */
+        BookingEvent: {
+            event_id: string;
+            template_id: string;
+            host_id: string | null;
+            /**
+             * Format: date
+             * @description yyyy-mm-dd in the workspace time zone.
+             */
+            date: string;
+            window_start_minute: number;
+            window_end_minute: number;
+            /** @enum {string} */
+            place: "at_host" | "in_house";
+            capacity: number;
+            minimum: number;
+            registered_count: number;
+            service_ids: string[];
+            resource_ids: string[];
+            price_override_ore: number | null;
+            status: components["schemas"]["BookingEventStatus"];
+            /** Format: date-time */
+            registration_closes_at: string;
+            slug: string;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: date-time */
+            updated_at: string;
+        };
+        CreateBookingEventInput: {
+            template_key: components["schemas"]["BookingEventTemplateKey"];
+            host_id?: string;
+            /** Format: date */
+            date: string;
+            window_start_minute: number;
+            window_end_minute?: number;
+            /** @enum {string} */
+            place: "at_host" | "in_house";
+            capacity?: number;
+            minimum?: number;
+            service_ids: string[];
+            resource_ids: string[];
+        };
+        ApiResponse_ContactPersonArray: components["schemas"]["Envelope_ContactPersonArray"];
+        ApiResponse_ContactPerson: components["schemas"]["Envelope_ContactPerson"];
+        ApiResponse_ContactRelations: components["schemas"]["Envelope_ContactRelations"];
+        ApiResponse_CreateContactRelationResult: components["schemas"]["Envelope_CreateContactRelationResult"];
+        ApiResponse_BookingEventArray: components["schemas"]["Envelope_BookingEventArray"];
+        ApiResponse_BookingEvent: components["schemas"]["Envelope_BookingEvent"];
+        Envelope_ContactPersonArray: {
+            data: components["schemas"]["ContactPerson"][];
+        };
+        Envelope_ContactPerson: {
+            data: components["schemas"]["ContactPerson"];
+        };
+        Envelope_ContactRelations: {
+            data: components["schemas"]["ContactRelations"];
+        };
+        Envelope_CreateContactRelationResult: {
+            data: components["schemas"]["CreateContactRelationResult"];
+        };
+        Envelope_BookingEventArray: {
+            data: components["schemas"]["BookingEvent"][];
+        };
+        Envelope_BookingEvent: {
+            data: components["schemas"]["BookingEvent"];
+        };
     };
     responses: {
         /** @description API error. */
@@ -3386,6 +3635,178 @@ interface operations {
             default: components["responses"]["ApiError"];
         };
     };
+    listContactPersons: {
+        parameters: {
+            query: {
+                contact_id: string;
+                include_inactive?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Contact persons. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ContactPersonArray"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    createContactPerson: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateContactPersonInput"];
+            };
+        };
+        responses: {
+            /** @description Created person. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ContactPerson"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    listContactRelations: {
+        parameters: {
+            query: {
+                contact_id: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Outgoing and incoming relations. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ContactRelations"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    createContactRelation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateContactRelationInput"];
+            };
+        };
+        responses: {
+            /** @description Created relation id. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_CreateContactRelationResult"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    listBookingEvents: {
+        parameters: {
+            query: {
+                /** @description Start of the window, `yyyy-mm-dd`, inclusive. */
+                from: string;
+                /** @description End of the window, `yyyy-mm-dd`, inclusive. */
+                to: string;
+                status?: components["schemas"]["BookingEventStatus"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Arrangementer in the window. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BookingEventArray"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    createBookingEvent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateBookingEventInput"];
+            };
+        };
+        responses: {
+            /** @description Created arrangement. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BookingEvent"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    getBookingEvent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["Id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Arrangement. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_BookingEvent"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
     getBooking: {
         parameters: {
             query?: never;