@medalsocial/sdk 1.8.0 → 1.9.0

package/dist/src/index.d.mts

@@ -655,6 +655,12 @@ interface Booking {
     booked_for_name: string | null;
     /** Birth year (not a birthdate) of whoever the appointment is for. */
     booked_for_birth_year: number | null;
+    /** The {@link ContactPerson} this booking was made for, if any. */
+    booked_for_person_id: string | null;
+    /** The {@link BookingEvent} this booking is a registration for, if any. */
+    event_id: string | null;
+    /** Position of this booking within its event's registrations, if any. */
+    event_order: number | null;
     /** Shared by every booking created in the same party request. */
     party_sequence_id: string | null;
     status: BookingStatus;
@@ -740,6 +746,8 @@ interface CreateBookingItemInput {
     booked_for_name?: string;
     /** Birth year (not a birthdate) of whoever the appointment is for. */
     booked_for_birth_year?: number;
+    /** Book this line on behalf of a {@link ContactPerson} rather than the contact. */
+    booked_for_person_id?: string;
 }
 /** The person the booking is made under. Phone is the CRM dedupe key. */
 interface BookingContactInput {
@@ -918,6 +926,113 @@ interface BookingAvailabilityOptions {
     /** Restrict slots to one resource. Defaults to every capable resource. */
     resource_id?: string;
 }
+/** How a {@link ContactPerson} or {@link ContactRelation} relates to a contact. */
+type RelationType = "guardian" | "owner" | "employer" | "caregiver" | "partner" | "custom";
+/** A person a contact books for — a child, a pet, an employee. No login of its own. */
+interface ContactPerson {
+    person_id: string;
+    contact_id: string;
+    name: string;
+    birth_year: number | null;
+    relation_type: RelationType;
+    relation_label: string | null;
+    notes: string | null;
+    active: boolean;
+    promoted_to_contact_id: string | null;
+    /** ISO 8601. */
+    created_at: string;
+    /** ISO 8601. */
+    updated_at: string;
+}
+/** Input for `bookings.persons.create(...)`. */
+interface CreateContactPersonInput {
+    contact_id: string;
+    name: string;
+    birth_year?: number;
+    relation_type: RelationType;
+    relation_label?: string;
+    notes?: string;
+}
+/** One directional relation between two contacts. */
+interface ContactRelation {
+    relation_id: string;
+    from_contact_id: string;
+    to_contact_id: string;
+    type: RelationType;
+    custom_label: string | null;
+    since: number | null;
+    note: string | null;
+    /** Empty string when the counterpart contact no longer exists. */
+    counterpart_name: string;
+    /** ISO 8601. */
+    created_at: string;
+}
+/** Relations a contact holds, split by direction. */
+interface ContactRelations {
+    outgoing: ContactRelation[];
+    incoming: ContactRelation[];
+}
+/** Input for `bookings.relations.create(...)`. */
+interface CreateContactRelationInput {
+    from_contact_id: string;
+    to_contact_id: string;
+    type: RelationType;
+    custom_label?: string;
+    since?: number;
+    note?: string;
+}
+/** Result of `bookings.relations.create(...)`. */
+interface CreateContactRelationResult {
+    relation_id: string;
+}
+/** Lifecycle state of an arrangement. */
+type BookingEventStatus = "draft" | "open" | "closed" | "completed" | "cancelled";
+/** Which prebuilt template an arrangement was created from. */
+type BookingEventTemplateKey = "kindergarten_visit" | "company_day" | "class" | "open_day" | "custom";
+/** An arrangement — a scheduled group session bookings register against. */
+interface BookingEvent {
+    event_id: string;
+    template_id: string;
+    host_id: string | null;
+    /** yyyy-mm-dd in the workspace time zone. */
+    date: string;
+    window_start_minute: number;
+    window_end_minute: number;
+    place: "at_host" | "in_house";
+    capacity: number;
+    minimum: number;
+    registered_count: number;
+    service_ids: string[];
+    resource_ids: string[];
+    price_override_ore: number | null;
+    status: BookingEventStatus;
+    /** ISO 8601. */
+    registration_closes_at: string;
+    slug: string;
+    /** ISO 8601. */
+    created_at: string;
+    /** ISO 8601. */
+    updated_at: string;
+}
+/** Options for `bookings.events.list(...)`. The window is `yyyy-mm-dd`, inclusive. */
+interface ListBookingEventsOptions {
+    from: string;
+    to: string;
+    status?: BookingEventStatus;
+}
+/** Input for `bookings.events.create(...)`. */
+interface CreateBookingEventInput {
+    template_key: BookingEventTemplateKey;
+    host_id?: string;
+    date: string;
+    window_start_minute: number;
+    window_end_minute?: number;
+    place: "at_host" | "in_house";
+    capacity?: number;
+    minimum?: number;
+    service_ids: string[];
+    resource_ids: string[];
+}
 
 /**
  * Customer-side booking management, addressed by the show-once manage token
@@ -948,6 +1063,45 @@ declare class BookingsManage {
      */
     reschedule(token: string, input: RescheduleBookingInput, options?: RequestOptions): Promise<ApiResponse<BookingRescheduleResult>>;
 }
+/**
+ * Persons a contact books for — children, pets, employees. Each has no login
+ * of its own; bookings made on their behalf still hang off the contact via
+ * `booked_for_person_id`.
+ */
+declare class BookingsPersons {
+    private client;
+    constructor(client: BaseClient);
+    /** Persons a contact books for. Active-only unless `include_inactive`. */
+    list(contactId: string, options?: {
+        include_inactive?: boolean;
+    }): Promise<ApiResponse<ContactPerson[]>>;
+    /** Add a person under a contact. */
+    create(input: CreateContactPersonInput, options?: RequestOptions): Promise<ApiResponse<ContactPerson>>;
+}
+/** Directional relations between contacts — guardian, partner, employer, and so on. */
+declare class BookingsRelations {
+    private client;
+    constructor(client: BaseClient);
+    /** Relations a contact holds, split into outgoing and incoming. */
+    list(contactId: string): Promise<ApiResponse<ContactRelations>>;
+    /** Create a relation from one contact to another. */
+    create(input: CreateContactRelationInput, options?: RequestOptions): Promise<ApiResponse<CreateContactRelationResult>>;
+}
+/**
+ * Arrangementer — scheduled group sessions bookings register against.
+ * Registration itself lands in a later release; this is the read/create
+ * surface for the events.
+ */
+declare class BookingsEvents {
+    private client;
+    constructor(client: BaseClient);
+    /** Arrangementer in a date range (`yyyy-mm-dd`, inclusive). */
+    list(options: ListBookingEventsOptions): Promise<ApiResponse<BookingEvent[]>>;
+    /** Get an arrangement by ID. */
+    get(id: string): Promise<ApiResponse<BookingEvent>>;
+    /** Create an arrangement from a template. */
+    create(input: CreateBookingEventInput, options?: RequestOptions): Promise<ApiResponse<BookingEvent>>;
+}
 /**
  * Appointment bookings: the service catalogue, free slots, and the bookings
  * themselves.
@@ -977,6 +1131,12 @@ declare class Bookings {
     private client;
     /** Customer-side actions addressed by manage token. */
     readonly manage: BookingsManage;
+    /** Persons a contact books for — children, pets, employees. */
+    readonly persons: BookingsPersons;
+    /** Directional relations between contacts. */
+    readonly relations: BookingsRelations;
+    /** Arrangementer — scheduled group sessions bookings register against. */
+    readonly events: BookingsEvents;
     constructor(client: BaseClient);
     /** List the bookable service catalogue. Active-only unless asked otherwise. */
     listServices(options?: ListBookingServicesOptions): Promise<ApiResponse<BookingService[]>>;
@@ -1790,6 +1950,22 @@ interface PortalFamilyMember {
     name: string;
     birth_year: number;
 }
+/** A person the contact books for — a child, a pet — with no login of its own. */
+interface PortalPerson {
+    person_id: string;
+    name: string;
+    birth_year: number | null;
+    relation_type: RelationType;
+    relation_label: string | null;
+    notes: string | null;
+    /** `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;
+}
+/** The workspace's own words for the person concept, e.g. `"Barn"`. */
+interface PortalLabels {
+    person: string;
+    persons: string;
+}
 /** The signed-in contact's own profile. */
 interface PortalProfile {
     contact_id: string;
@@ -1798,6 +1974,8 @@ interface PortalProfile {
     last_name: string | null;
     phone: string | null;
     family: PortalFamilyMember[];
+    persons: PortalPerson[];
+    labels: PortalLabels;
     marketing_consent: boolean;
     /** Unix timestamp in milliseconds. */
     created_at: number;
@@ -1850,6 +2028,15 @@ interface PortalConsentRecord {
     revoked_at: number | null;
     source: string;
 }
+/** A relation the exporting contact is a party to; only the counterpart's display name is exposed. */
+interface PortalExportRelation {
+    direction: "outgoing" | "incoming";
+    type: RelationType;
+    custom_label: string | null;
+    since: number | null;
+    note: string | null;
+    counterpart_name: string;
+}
 /** Everything the workspace holds about the signed-in contact (GDPR Art. 15). */
 interface PortalExport {
     /** Unix timestamp in milliseconds. */
@@ -1858,6 +2045,7 @@ interface PortalExport {
     family: PortalFamilyMember[];
     consents: PortalConsentRecord[];
     bookings: PortalBooking[];
+    relations: PortalExportRelation[];
 }
 
 /**
@@ -2635,4 +2823,4 @@ declare class Medal {
 /** Convenience factory — equivalent to `new Medal(apiKey, options)`. */
 declare function createMedalClient(apiKey: string, options?: MedalOptions): Medal;
 
-export { type Activity, type AddNoteInput, type ApiResponse, type AutoConfirmContext, type AutoConfirmOptions, BaseClient, type BatchSendInput, type BatchSendResult, type BatchSendSummary, type Booking, type BookingActionResult, type BookingAvailabilityOptions, type BookingCancelledBy, type BookingClaimableCreatedVia, type BookingContactInput, type BookingCreateResult, type BookingCreatedVia, type BookingPaymentStatus, type BookingRescheduleResult, type BookingResource, type BookingResourceType, type BookingScheduleDay, type BookingScheduleOptions, type BookingService, type BookingSlot, type BookingStatus, type BookingTimestampInput, Bookings, type BookingsPage, type BookingsPagination, CAPABILITY_IDS, CAPABILITY_ROUTES, type CancelBookingInput, type CapabilityConfirmation, CapabilityConfirmations, CapabilityConfirmer, type CapabilityId, type CapabilityPathParamValue, type CapabilityRoute, type CapabilityWriteBodies, type CapabilityWriteRequest, type Channel, type ChannelConnectedEvent, type ChannelConnection, type ChannelConnectionDisconnectResult, type ChannelConnectionState, type ChannelDisconnectReason, type ChannelDisconnectedEvent, Channels, type ConnectLink, type ConnectLinkCreateResult, type ConnectLinkRevokeResult, type ConnectLinkStatus, type ConsentRecord, type ConsentResult, type ConsentType, type Contact, type ContactConsents, type ContactCreateResult, type ContactNoteResult, type ContactRemoveResult, type ContactStatus, type ContactUpdateResult, Contacts, type Conversation, type ConversationAssignedEvent, type ConversationCreatedEvent, type ConversationMessage, type ConversationStatus, type ConversationStatusChangedEvent, type ConversationUpdateResult, type CookieCategoryConsent, type CookieConsentInput, type CreateBookingInput, type CreateBookingItemInput, type CreateConnectLinkInput, type CreateContactInput, type CreateDealInput, type CreatePostInput, type CreateReplyInput, type CreateWebhookInput, type CreatedBooking, DEFAULT_WEBHOOK_TOLERANCE_MS, type Deal, type DealCreateResult, type DealRemoveResult, type DealStatus, type DealUpdateResult, Deals, type EmailSend, type EmailSendResult, type EmailStatus, type EmailTemplate, type EmailTemplateDetail, Emails, Gdpr, type GdprExport, type GetTemplateOptions, Helpdesk, type HelpdeskMessageType, type ImportContactInput, type ImportContactsResult, type IssueCapabilityConfirmationInput, type ListBookingServicesOptions, type ListBookingsOptions, type ListConnectLinksOptions, type ListContactsOptions, type ListConversationsOptions, type ListDealsOptions, type ListDeliveriesOptions, type ListPostsOptions, type ManageSummary, Medal, MedalApiError, type MedalOptions, type MessageAuthorType, type MessageDeliveryStatus, type MessageDeliveryUpdatedEvent, type MessageReceivedEvent, type MessageSentEvent, type PaginatedResponse, type PaginationOptions, Portal, type PortalBooking, type PortalBookingStatus, type PortalBookings, type PortalConsentRecord, type PortalContactSummary, type PortalExport, type PortalFamilyMember, type PortalLoginStartInput, type PortalLoginStartResult, type PortalProfile, type PortalProfilePatch, type PortalSession, type PortalVerifyInput, type Post, type PostDetail, type PostType, type PostVariant, Posts, type PublishResult, type RecordConsentInput, type ReplyCreateResult, type RequestOptions, type RescheduleBookingInput, Scan, type ScanCompany, type ScanCreateInput, type ScanCreateResult, type ScanJob, type ScanResultPayload, type ScanStatus, type ScanSubScores, type SchedulePostInput, type ScheduleResult, type SendEmailInput, type TestPingEvent, type UpdateBookingInput, type UpdateContactInput, type UpdateConversationInput, type UpdateDealInput, type UpdatePostInput, type UpdateWebhookInput, type VerifyWebhookSignatureInput, type WaitForScanOptions, type WebhookChannelLifecycleData, type WebhookConversationSnapshot, type WebhookDeleteResult, type WebhookDelivery, type WebhookEndpoint, type WebhookEvent, type WebhookMessageSnapshot, type WebhookTestResult, WebhookVerificationError, type WebhookVerificationErrorCode, Webhooks, type Workspace, Workspaces, createMedalClient, Medal as default, verifyWebhookSignature };
+export { type Activity, type AddNoteInput, type ApiResponse, type AutoConfirmContext, type AutoConfirmOptions, BaseClient, type BatchSendInput, type BatchSendResult, type BatchSendSummary, type Booking, type BookingActionResult, type BookingAvailabilityOptions, type BookingCancelledBy, type BookingClaimableCreatedVia, type BookingContactInput, type BookingCreateResult, type BookingCreatedVia, type BookingEvent, type BookingEventStatus, type BookingEventTemplateKey, type BookingPaymentStatus, type BookingRescheduleResult, type BookingResource, type BookingResourceType, type BookingScheduleDay, type BookingScheduleOptions, type BookingService, type BookingSlot, type BookingStatus, type BookingTimestampInput, Bookings, type BookingsPage, type BookingsPagination, CAPABILITY_IDS, CAPABILITY_ROUTES, type CancelBookingInput, type CapabilityConfirmation, CapabilityConfirmations, CapabilityConfirmer, type CapabilityId, type CapabilityPathParamValue, type CapabilityRoute, type CapabilityWriteBodies, type CapabilityWriteRequest, type Channel, type ChannelConnectedEvent, type ChannelConnection, type ChannelConnectionDisconnectResult, type ChannelConnectionState, type ChannelDisconnectReason, type ChannelDisconnectedEvent, Channels, type ConnectLink, type ConnectLinkCreateResult, type ConnectLinkRevokeResult, type ConnectLinkStatus, type ConsentRecord, type ConsentResult, type ConsentType, type Contact, type ContactConsents, type ContactCreateResult, type ContactNoteResult, type ContactPerson, type ContactRelation, type ContactRelations, type ContactRemoveResult, type ContactStatus, type ContactUpdateResult, Contacts, type Conversation, type ConversationAssignedEvent, type ConversationCreatedEvent, type ConversationMessage, type ConversationStatus, type ConversationStatusChangedEvent, type ConversationUpdateResult, type CookieCategoryConsent, type CookieConsentInput, type CreateBookingEventInput, type CreateBookingInput, type CreateBookingItemInput, type CreateConnectLinkInput, type CreateContactInput, type CreateContactPersonInput, type CreateContactRelationInput, type CreateContactRelationResult, type CreateDealInput, type CreatePostInput, type CreateReplyInput, type CreateWebhookInput, type CreatedBooking, DEFAULT_WEBHOOK_TOLERANCE_MS, type Deal, type DealCreateResult, type DealRemoveResult, type DealStatus, type DealUpdateResult, Deals, type EmailSend, type EmailSendResult, type EmailStatus, type EmailTemplate, type EmailTemplateDetail, Emails, Gdpr, type GdprExport, type GetTemplateOptions, Helpdesk, type HelpdeskMessageType, type ImportContactInput, type ImportContactsResult, type IssueCapabilityConfirmationInput, type ListBookingEventsOptions, type ListBookingServicesOptions, type ListBookingsOptions, type ListConnectLinksOptions, type ListContactsOptions, type ListConversationsOptions, type ListDealsOptions, type ListDeliveriesOptions, type ListPostsOptions, type ManageSummary, Medal, MedalApiError, type MedalOptions, type MessageAuthorType, type MessageDeliveryStatus, type MessageDeliveryUpdatedEvent, type MessageReceivedEvent, type MessageSentEvent, type PaginatedResponse, type PaginationOptions, Portal, type PortalBooking, type PortalBookingStatus, type PortalBookings, type PortalConsentRecord, type PortalContactSummary, type PortalExport, type PortalExportRelation, type PortalFamilyMember, type PortalLabels, type PortalLoginStartInput, type PortalLoginStartResult, type PortalPerson, type PortalProfile, type PortalProfilePatch, type PortalSession, type PortalVerifyInput, type Post, type PostDetail, type PostType, type PostVariant, Posts, type PublishResult, type RecordConsentInput, type RelationType, type ReplyCreateResult, type RequestOptions, type RescheduleBookingInput, Scan, type ScanCompany, type ScanCreateInput, type ScanCreateResult, type ScanJob, type ScanResultPayload, type ScanStatus, type ScanSubScores, type SchedulePostInput, type ScheduleResult, type SendEmailInput, type TestPingEvent, type UpdateBookingInput, type UpdateContactInput, type UpdateConversationInput, type UpdateDealInput, type UpdatePostInput, type UpdateWebhookInput, type VerifyWebhookSignatureInput, type WaitForScanOptions, type WebhookChannelLifecycleData, type WebhookConversationSnapshot, type WebhookDeleteResult, type WebhookDelivery, type WebhookEndpoint, type WebhookEvent, type WebhookMessageSnapshot, type WebhookTestResult, WebhookVerificationError, type WebhookVerificationErrorCode, Webhooks, type Workspace, Workspaces, createMedalClient, Medal as default, verifyWebhookSignature };

package/dist/src/index.d.ts

@@ -655,6 +655,12 @@ interface Booking {
     booked_for_name: string | null;
     /** Birth year (not a birthdate) of whoever the appointment is for. */
     booked_for_birth_year: number | null;
+    /** The {@link ContactPerson} this booking was made for, if any. */
+    booked_for_person_id: string | null;
+    /** The {@link BookingEvent} this booking is a registration for, if any. */
+    event_id: string | null;
+    /** Position of this booking within its event's registrations, if any. */
+    event_order: number | null;
     /** Shared by every booking created in the same party request. */
     party_sequence_id: string | null;
     status: BookingStatus;
@@ -740,6 +746,8 @@ interface CreateBookingItemInput {
     booked_for_name?: string;
     /** Birth year (not a birthdate) of whoever the appointment is for. */
     booked_for_birth_year?: number;
+    /** Book this line on behalf of a {@link ContactPerson} rather than the contact. */
+    booked_for_person_id?: string;
 }
 /** The person the booking is made under. Phone is the CRM dedupe key. */
 interface BookingContactInput {
@@ -918,6 +926,113 @@ interface BookingAvailabilityOptions {
     /** Restrict slots to one resource. Defaults to every capable resource. */
     resource_id?: string;
 }
+/** How a {@link ContactPerson} or {@link ContactRelation} relates to a contact. */
+type RelationType = "guardian" | "owner" | "employer" | "caregiver" | "partner" | "custom";
+/** A person a contact books for — a child, a pet, an employee. No login of its own. */
+interface ContactPerson {
+    person_id: string;
+    contact_id: string;
+    name: string;
+    birth_year: number | null;
+    relation_type: RelationType;
+    relation_label: string | null;
+    notes: string | null;
+    active: boolean;
+    promoted_to_contact_id: string | null;
+    /** ISO 8601. */
+    created_at: string;
+    /** ISO 8601. */
+    updated_at: string;
+}
+/** Input for `bookings.persons.create(...)`. */
+interface CreateContactPersonInput {
+    contact_id: string;
+    name: string;
+    birth_year?: number;
+    relation_type: RelationType;
+    relation_label?: string;
+    notes?: string;
+}
+/** One directional relation between two contacts. */
+interface ContactRelation {
+    relation_id: string;
+    from_contact_id: string;
+    to_contact_id: string;
+    type: RelationType;
+    custom_label: string | null;
+    since: number | null;
+    note: string | null;
+    /** Empty string when the counterpart contact no longer exists. */
+    counterpart_name: string;
+    /** ISO 8601. */
+    created_at: string;
+}
+/** Relations a contact holds, split by direction. */
+interface ContactRelations {
+    outgoing: ContactRelation[];
+    incoming: ContactRelation[];
+}
+/** Input for `bookings.relations.create(...)`. */
+interface CreateContactRelationInput {
+    from_contact_id: string;
+    to_contact_id: string;
+    type: RelationType;
+    custom_label?: string;
+    since?: number;
+    note?: string;
+}
+/** Result of `bookings.relations.create(...)`. */
+interface CreateContactRelationResult {
+    relation_id: string;
+}
+/** Lifecycle state of an arrangement. */
+type BookingEventStatus = "draft" | "open" | "closed" | "completed" | "cancelled";
+/** Which prebuilt template an arrangement was created from. */
+type BookingEventTemplateKey = "kindergarten_visit" | "company_day" | "class" | "open_day" | "custom";
+/** An arrangement — a scheduled group session bookings register against. */
+interface BookingEvent {
+    event_id: string;
+    template_id: string;
+    host_id: string | null;
+    /** yyyy-mm-dd in the workspace time zone. */
+    date: string;
+    window_start_minute: number;
+    window_end_minute: number;
+    place: "at_host" | "in_house";
+    capacity: number;
+    minimum: number;
+    registered_count: number;
+    service_ids: string[];
+    resource_ids: string[];
+    price_override_ore: number | null;
+    status: BookingEventStatus;
+    /** ISO 8601. */
+    registration_closes_at: string;
+    slug: string;
+    /** ISO 8601. */
+    created_at: string;
+    /** ISO 8601. */
+    updated_at: string;
+}
+/** Options for `bookings.events.list(...)`. The window is `yyyy-mm-dd`, inclusive. */
+interface ListBookingEventsOptions {
+    from: string;
+    to: string;
+    status?: BookingEventStatus;
+}
+/** Input for `bookings.events.create(...)`. */
+interface CreateBookingEventInput {
+    template_key: BookingEventTemplateKey;
+    host_id?: string;
+    date: string;
+    window_start_minute: number;
+    window_end_minute?: number;
+    place: "at_host" | "in_house";
+    capacity?: number;
+    minimum?: number;
+    service_ids: string[];
+    resource_ids: string[];
+}
 
 /**
  * Customer-side booking management, addressed by the show-once manage token
@@ -948,6 +1063,45 @@ declare class BookingsManage {
      */
     reschedule(token: string, input: RescheduleBookingInput, options?: RequestOptions): Promise<ApiResponse<BookingRescheduleResult>>;
 }
+/**
+ * Persons a contact books for — children, pets, employees. Each has no login
+ * of its own; bookings made on their behalf still hang off the contact via
+ * `booked_for_person_id`.
+ */
+declare class BookingsPersons {
+    private client;
+    constructor(client: BaseClient);
+    /** Persons a contact books for. Active-only unless `include_inactive`. */
+    list(contactId: string, options?: {
+        include_inactive?: boolean;
+    }): Promise<ApiResponse<ContactPerson[]>>;
+    /** Add a person under a contact. */
+    create(input: CreateContactPersonInput, options?: RequestOptions): Promise<ApiResponse<ContactPerson>>;
+}
+/** Directional relations between contacts — guardian, partner, employer, and so on. */
+declare class BookingsRelations {
+    private client;
+    constructor(client: BaseClient);
+    /** Relations a contact holds, split into outgoing and incoming. */
+    list(contactId: string): Promise<ApiResponse<ContactRelations>>;
+    /** Create a relation from one contact to another. */
+    create(input: CreateContactRelationInput, options?: RequestOptions): Promise<ApiResponse<CreateContactRelationResult>>;
+}
+/**
+ * Arrangementer — scheduled group sessions bookings register against.
+ * Registration itself lands in a later release; this is the read/create
+ * surface for the events.
+ */
+declare class BookingsEvents {
+    private client;
+    constructor(client: BaseClient);
+    /** Arrangementer in a date range (`yyyy-mm-dd`, inclusive). */
+    list(options: ListBookingEventsOptions): Promise<ApiResponse<BookingEvent[]>>;
+    /** Get an arrangement by ID. */
+    get(id: string): Promise<ApiResponse<BookingEvent>>;
+    /** Create an arrangement from a template. */
+    create(input: CreateBookingEventInput, options?: RequestOptions): Promise<ApiResponse<BookingEvent>>;
+}
 /**
  * Appointment bookings: the service catalogue, free slots, and the bookings
  * themselves.
@@ -977,6 +1131,12 @@ declare class Bookings {
     private client;
     /** Customer-side actions addressed by manage token. */
     readonly manage: BookingsManage;
+    /** Persons a contact books for — children, pets, employees. */
+    readonly persons: BookingsPersons;
+    /** Directional relations between contacts. */
+    readonly relations: BookingsRelations;
+    /** Arrangementer — scheduled group sessions bookings register against. */
+    readonly events: BookingsEvents;
     constructor(client: BaseClient);
     /** List the bookable service catalogue. Active-only unless asked otherwise. */
     listServices(options?: ListBookingServicesOptions): Promise<ApiResponse<BookingService[]>>;
@@ -1790,6 +1950,22 @@ interface PortalFamilyMember {
     name: string;
     birth_year: number;
 }
+/** A person the contact books for — a child, a pet — with no login of its own. */
+interface PortalPerson {
+    person_id: string;
+    name: string;
+    birth_year: number | null;
+    relation_type: RelationType;
+    relation_label: string | null;
+    notes: string | null;
+    /** `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;
+}
+/** The workspace's own words for the person concept, e.g. `"Barn"`. */
+interface PortalLabels {
+    person: string;
+    persons: string;
+}
 /** The signed-in contact's own profile. */
 interface PortalProfile {
     contact_id: string;
@@ -1798,6 +1974,8 @@ interface PortalProfile {
     last_name: string | null;
     phone: string | null;
     family: PortalFamilyMember[];
+    persons: PortalPerson[];
+    labels: PortalLabels;
     marketing_consent: boolean;
     /** Unix timestamp in milliseconds. */
     created_at: number;
@@ -1850,6 +2028,15 @@ interface PortalConsentRecord {
     revoked_at: number | null;
     source: string;
 }
+/** A relation the exporting contact is a party to; only the counterpart's display name is exposed. */
+interface PortalExportRelation {
+    direction: "outgoing" | "incoming";
+    type: RelationType;
+    custom_label: string | null;
+    since: number | null;
+    note: string | null;
+    counterpart_name: string;
+}
 /** Everything the workspace holds about the signed-in contact (GDPR Art. 15). */
 interface PortalExport {
     /** Unix timestamp in milliseconds. */
@@ -1858,6 +2045,7 @@ interface PortalExport {
     family: PortalFamilyMember[];
     consents: PortalConsentRecord[];
     bookings: PortalBooking[];
+    relations: PortalExportRelation[];
 }
 
 /**
@@ -2635,4 +2823,4 @@ declare class Medal {
 /** Convenience factory — equivalent to `new Medal(apiKey, options)`. */
 declare function createMedalClient(apiKey: string, options?: MedalOptions): Medal;
 
-export { type Activity, type AddNoteInput, type ApiResponse, type AutoConfirmContext, type AutoConfirmOptions, BaseClient, type BatchSendInput, type BatchSendResult, type BatchSendSummary, type Booking, type BookingActionResult, type BookingAvailabilityOptions, type BookingCancelledBy, type BookingClaimableCreatedVia, type BookingContactInput, type BookingCreateResult, type BookingCreatedVia, type BookingPaymentStatus, type BookingRescheduleResult, type BookingResource, type BookingResourceType, type BookingScheduleDay, type BookingScheduleOptions, type BookingService, type BookingSlot, type BookingStatus, type BookingTimestampInput, Bookings, type BookingsPage, type BookingsPagination, CAPABILITY_IDS, CAPABILITY_ROUTES, type CancelBookingInput, type CapabilityConfirmation, CapabilityConfirmations, CapabilityConfirmer, type CapabilityId, type CapabilityPathParamValue, type CapabilityRoute, type CapabilityWriteBodies, type CapabilityWriteRequest, type Channel, type ChannelConnectedEvent, type ChannelConnection, type ChannelConnectionDisconnectResult, type ChannelConnectionState, type ChannelDisconnectReason, type ChannelDisconnectedEvent, Channels, type ConnectLink, type ConnectLinkCreateResult, type ConnectLinkRevokeResult, type ConnectLinkStatus, type ConsentRecord, type ConsentResult, type ConsentType, type Contact, type ContactConsents, type ContactCreateResult, type ContactNoteResult, type ContactRemoveResult, type ContactStatus, type ContactUpdateResult, Contacts, type Conversation, type ConversationAssignedEvent, type ConversationCreatedEvent, type ConversationMessage, type ConversationStatus, type ConversationStatusChangedEvent, type ConversationUpdateResult, type CookieCategoryConsent, type CookieConsentInput, type CreateBookingInput, type CreateBookingItemInput, type CreateConnectLinkInput, type CreateContactInput, type CreateDealInput, type CreatePostInput, type CreateReplyInput, type CreateWebhookInput, type CreatedBooking, DEFAULT_WEBHOOK_TOLERANCE_MS, type Deal, type DealCreateResult, type DealRemoveResult, type DealStatus, type DealUpdateResult, Deals, type EmailSend, type EmailSendResult, type EmailStatus, type EmailTemplate, type EmailTemplateDetail, Emails, Gdpr, type GdprExport, type GetTemplateOptions, Helpdesk, type HelpdeskMessageType, type ImportContactInput, type ImportContactsResult, type IssueCapabilityConfirmationInput, type ListBookingServicesOptions, type ListBookingsOptions, type ListConnectLinksOptions, type ListContactsOptions, type ListConversationsOptions, type ListDealsOptions, type ListDeliveriesOptions, type ListPostsOptions, type ManageSummary, Medal, MedalApiError, type MedalOptions, type MessageAuthorType, type MessageDeliveryStatus, type MessageDeliveryUpdatedEvent, type MessageReceivedEvent, type MessageSentEvent, type PaginatedResponse, type PaginationOptions, Portal, type PortalBooking, type PortalBookingStatus, type PortalBookings, type PortalConsentRecord, type PortalContactSummary, type PortalExport, type PortalFamilyMember, type PortalLoginStartInput, type PortalLoginStartResult, type PortalProfile, type PortalProfilePatch, type PortalSession, type PortalVerifyInput, type Post, type PostDetail, type PostType, type PostVariant, Posts, type PublishResult, type RecordConsentInput, type ReplyCreateResult, type RequestOptions, type RescheduleBookingInput, Scan, type ScanCompany, type ScanCreateInput, type ScanCreateResult, type ScanJob, type ScanResultPayload, type ScanStatus, type ScanSubScores, type SchedulePostInput, type ScheduleResult, type SendEmailInput, type TestPingEvent, type UpdateBookingInput, type UpdateContactInput, type UpdateConversationInput, type UpdateDealInput, type UpdatePostInput, type UpdateWebhookInput, type VerifyWebhookSignatureInput, type WaitForScanOptions, type WebhookChannelLifecycleData, type WebhookConversationSnapshot, type WebhookDeleteResult, type WebhookDelivery, type WebhookEndpoint, type WebhookEvent, type WebhookMessageSnapshot, type WebhookTestResult, WebhookVerificationError, type WebhookVerificationErrorCode, Webhooks, type Workspace, Workspaces, createMedalClient, Medal as default, verifyWebhookSignature };
+export { type Activity, type AddNoteInput, type ApiResponse, type AutoConfirmContext, type AutoConfirmOptions, BaseClient, type BatchSendInput, type BatchSendResult, type BatchSendSummary, type Booking, type BookingActionResult, type BookingAvailabilityOptions, type BookingCancelledBy, type BookingClaimableCreatedVia, type BookingContactInput, type BookingCreateResult, type BookingCreatedVia, type BookingEvent, type BookingEventStatus, type BookingEventTemplateKey, type BookingPaymentStatus, type BookingRescheduleResult, type BookingResource, type BookingResourceType, type BookingScheduleDay, type BookingScheduleOptions, type BookingService, type BookingSlot, type BookingStatus, type BookingTimestampInput, Bookings, type BookingsPage, type BookingsPagination, CAPABILITY_IDS, CAPABILITY_ROUTES, type CancelBookingInput, type CapabilityConfirmation, CapabilityConfirmations, CapabilityConfirmer, type CapabilityId, type CapabilityPathParamValue, type CapabilityRoute, type CapabilityWriteBodies, type CapabilityWriteRequest, type Channel, type ChannelConnectedEvent, type ChannelConnection, type ChannelConnectionDisconnectResult, type ChannelConnectionState, type ChannelDisconnectReason, type ChannelDisconnectedEvent, Channels, type ConnectLink, type ConnectLinkCreateResult, type ConnectLinkRevokeResult, type ConnectLinkStatus, type ConsentRecord, type ConsentResult, type ConsentType, type Contact, type ContactConsents, type ContactCreateResult, type ContactNoteResult, type ContactPerson, type ContactRelation, type ContactRelations, type ContactRemoveResult, type ContactStatus, type ContactUpdateResult, Contacts, type Conversation, type ConversationAssignedEvent, type ConversationCreatedEvent, type ConversationMessage, type ConversationStatus, type ConversationStatusChangedEvent, type ConversationUpdateResult, type CookieCategoryConsent, type CookieConsentInput, type CreateBookingEventInput, type CreateBookingInput, type CreateBookingItemInput, type CreateConnectLinkInput, type CreateContactInput, type CreateContactPersonInput, type CreateContactRelationInput, type CreateContactRelationResult, type CreateDealInput, type CreatePostInput, type CreateReplyInput, type CreateWebhookInput, type CreatedBooking, DEFAULT_WEBHOOK_TOLERANCE_MS, type Deal, type DealCreateResult, type DealRemoveResult, type DealStatus, type DealUpdateResult, Deals, type EmailSend, type EmailSendResult, type EmailStatus, type EmailTemplate, type EmailTemplateDetail, Emails, Gdpr, type GdprExport, type GetTemplateOptions, Helpdesk, type HelpdeskMessageType, type ImportContactInput, type ImportContactsResult, type IssueCapabilityConfirmationInput, type ListBookingEventsOptions, type ListBookingServicesOptions, type ListBookingsOptions, type ListConnectLinksOptions, type ListContactsOptions, type ListConversationsOptions, type ListDealsOptions, type ListDeliveriesOptions, type ListPostsOptions, type ManageSummary, Medal, MedalApiError, type MedalOptions, type MessageAuthorType, type MessageDeliveryStatus, type MessageDeliveryUpdatedEvent, type MessageReceivedEvent, type MessageSentEvent, type PaginatedResponse, type PaginationOptions, Portal, type PortalBooking, type PortalBookingStatus, type PortalBookings, type PortalConsentRecord, type PortalContactSummary, type PortalExport, type PortalExportRelation, type PortalFamilyMember, type PortalLabels, type PortalLoginStartInput, type PortalLoginStartResult, type PortalPerson, type PortalProfile, type PortalProfilePatch, type PortalSession, type PortalVerifyInput, type Post, type PostDetail, type PostType, type PostVariant, Posts, type PublishResult, type RecordConsentInput, type RelationType, type ReplyCreateResult, type RequestOptions, type RescheduleBookingInput, Scan, type ScanCompany, type ScanCreateInput, type ScanCreateResult, type ScanJob, type ScanResultPayload, type ScanStatus, type ScanSubScores, type SchedulePostInput, type ScheduleResult, type SendEmailInput, type TestPingEvent, type UpdateBookingInput, type UpdateContactInput, type UpdateConversationInput, type UpdateDealInput, type UpdatePostInput, type UpdateWebhookInput, type VerifyWebhookSignatureInput, type WaitForScanOptions, type WebhookChannelLifecycleData, type WebhookConversationSnapshot, type WebhookDeleteResult, type WebhookDelivery, type WebhookEndpoint, type WebhookEvent, type WebhookMessageSnapshot, type WebhookTestResult, WebhookVerificationError, type WebhookVerificationErrorCode, Webhooks, type Workspace, Workspaces, createMedalClient, Medal as default, verifyWebhookSignature };

package/dist/src/index.js

@@ -373,14 +373,75 @@ var BookingsManage = class {
     );
   }
 };
+var BookingsPersons = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /** Persons a contact books for. Active-only unless `include_inactive`. */
+  async list(contactId, options) {
+    const params = { contact_id: contactId };
+    if (options?.include_inactive !== void 0) {
+      params.include_inactive = String(options.include_inactive);
+    }
+    return this.client.get("/api/v1/bookings/persons", params);
+  }
+  /** Add a person under a contact. */
+  async create(input, options) {
+    return this.client.postOnce("/api/v1/bookings/persons", input, options);
+  }
+};
+var BookingsRelations = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /** Relations a contact holds, split into outgoing and incoming. */
+  async list(contactId) {
+    return this.client.get("/api/v1/bookings/relations", { contact_id: contactId });
+  }
+  /** Create a relation from one contact to another. */
+  async create(input, options) {
+    return this.client.postOnce("/api/v1/bookings/relations", input, options);
+  }
+};
+var BookingsEvents = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /** Arrangementer in a date range (`yyyy-mm-dd`, inclusive). */
+  async list(options) {
+    const params = { from: options.from, to: options.to };
+    if (options.status) params.status = options.status;
+    return this.client.get("/api/v1/bookings/events", params);
+  }
+  /** Get an arrangement by ID. */
+  async get(id) {
+    return this.client.get(`/api/v1/bookings/events/${encodeURIComponent(id)}`);
+  }
+  /** Create an arrangement from a template. */
+  async create(input, options) {
+    return this.client.postOnce("/api/v1/bookings/events", input, options);
+  }
+};
 var Bookings = class {
   constructor(client) {
     this.client = client;
     this.manage = new BookingsManage(client);
+    this.persons = new BookingsPersons(client);
+    this.relations = new BookingsRelations(client);
+    this.events = new BookingsEvents(client);
   }
   client;
   /** Customer-side actions addressed by manage token. */
   manage;
+  /** Persons a contact books for — children, pets, employees. */
+  persons;
+  /** Directional relations between contacts. */
+  relations;
+  /** Arrangementer — scheduled group sessions bookings register against. */
+  events;
   /** List the bookable service catalogue. Active-only unless asked otherwise. */
   async listServices(options) {
     const params = {};