@medalsocial/sdk 1.7.0 → 1.8.0

package/dist/pilot/index.d.mts

@@ -17,9 +17,9 @@ declare const CreateContactSchema: z.ZodObject<{
     company: z.ZodOptional<z.ZodString>;
     job_title: z.ZodOptional<z.ZodString>;
     status: z.ZodOptional<z.ZodEnum<{
-        customer: "customer";
         lead: "lead";
         prospect: "prospect";
+        customer: "customer";
         churned: "churned";
         archived: "archived";
     }>>;
@@ -95,9 +95,9 @@ declare function createMedalTools(client: Medal): {
             company: z.ZodOptional<z.ZodString>;
             job_title: z.ZodOptional<z.ZodString>;
             status: z.ZodOptional<z.ZodEnum<{
-                customer: "customer";
                 lead: "lead";
                 prospect: "prospect";
+                customer: "customer";
                 churned: "churned";
                 archived: "archived";
             }>>;

package/dist/pilot/index.d.ts

@@ -17,9 +17,9 @@ declare const CreateContactSchema: z.ZodObject<{
     company: z.ZodOptional<z.ZodString>;
     job_title: z.ZodOptional<z.ZodString>;
     status: z.ZodOptional<z.ZodEnum<{
-        customer: "customer";
         lead: "lead";
         prospect: "prospect";
+        customer: "customer";
         churned: "churned";
         archived: "archived";
     }>>;
@@ -95,9 +95,9 @@ declare function createMedalTools(client: Medal): {
             company: z.ZodOptional<z.ZodString>;
             job_title: z.ZodOptional<z.ZodString>;
             status: z.ZodOptional<z.ZodEnum<{
-                customer: "customer";
                 lead: "lead";
                 prospect: "prospect";
+                customer: "customer";
                 churned: "churned";
                 archived: "archived";
             }>>;

package/dist/src/index.d.mts

@@ -527,7 +527,7 @@ interface ClientConfig {
     timeout: number;
     userAgent: string;
 }
-/** Per-request options for write operations. */
+/** Per-request options. `headers` applies to every verb; the named options only matter on writes. */
 interface RequestOptions {
     /**
      * Idempotency key sent as the `Idempotency-Key` header. Retries with the
@@ -560,6 +560,22 @@ interface RequestOptions {
      * Ignored on routes that do not require a capability confirmation.
      */
     autoConfirm?: AutoConfirmOptions | false;
+    /**
+     * Set to `false` to send the request exactly once — no automatic retry on
+     * 429/5xx. Use it for writes whose FIRST attempt may have succeeded even
+     * though the response was lost: a one-time code that is burned on use, a
+     * logout or erasure that revokes the very credential a retry would present.
+     * A retry there does not repeat the operation, it misreports it as failed.
+     * Defaults to `true`.
+     */
+    retry?: boolean;
+    /**
+     * Extra request headers, e.g. `x-portal-session` for the customer portal.
+     * Applied first: the named options (`idempotencyKey`,
+     * `capabilityConfirmation`) win over a same-named entry here, so a bag can
+     * never smuggle in a key the SDK did not resolve.
+     */
+    headers?: Record<string, string>;
 }
 /**
  * Low-level HTTP client used by all resource classes.
@@ -570,7 +586,7 @@ declare class BaseClient {
     readonly config: ClientConfig;
     constructor(config: ClientConfig);
     /** Execute an authenticated GET request and return the parsed JSON body. */
-    get<T>(path: string, params?: Record<string, string | undefined>): Promise<T>;
+    get<T>(path: string, params?: Record<string, string | undefined>, options?: Pick<RequestOptions, "headers">): Promise<T>;
     /** Execute an authenticated POST request with a JSON body. */
     post<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
     /**
@@ -1732,6 +1748,210 @@ declare class Helpdesk {
     constructor(client: BaseClient, confirmer?: CapabilityConfirmer);
 }
 
+/** Input for starting an e-mail one-time-code login. */
+interface PortalLoginStartInput {
+    /** The address the code is sent to. */
+    email: string;
+    /** Locale for the e-mail (e.g. `nb`, `en`); the workspace default when omitted. */
+    locale?: string;
+}
+/**
+ * Result of a login start. Always `"sent"`, whether or not the address is a
+ * known contact — the route is enumeration-safe by design.
+ */
+interface PortalLoginStartResult {
+    status: "sent";
+}
+/** Input for exchanging an e-mailed code for a portal session. */
+interface PortalVerifyInput {
+    /** The address the code was sent to. */
+    email: string;
+    /** The one-time code from the e-mail. */
+    code: string;
+}
+/** The contact a portal session belongs to. */
+interface PortalContactSummary {
+    contact_id: string;
+    first_name: string | null;
+}
+/**
+ * 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.
+ */
+interface PortalSession {
+    session_token: string;
+    /** Unix timestamp in milliseconds. */
+    expires_at: number;
+    contact: PortalContactSummary;
+}
+/** A family member the contact books on behalf of. */
+interface PortalFamilyMember {
+    name: string;
+    birth_year: number;
+}
+/** The signed-in contact's own profile. */
+interface PortalProfile {
+    contact_id: string;
+    email: string;
+    first_name: string | null;
+    last_name: string | null;
+    phone: string | null;
+    family: PortalFamilyMember[];
+    marketing_consent: boolean;
+    /** Unix timestamp in milliseconds. */
+    created_at: number;
+}
+/** Fields the signed-in contact may change on their own profile. */
+interface PortalProfilePatch {
+    first_name?: string;
+    last_name?: string;
+    /** `null` clears the number. */
+    phone?: string | null;
+    /** Replaces the whole list. */
+    family?: PortalFamilyMember[];
+    /** Records a marketing_email consent change with source 'portal'. */
+    marketing_consent?: boolean;
+}
+/** Lifecycle state of a booking as seen from the portal. */
+type PortalBookingStatus = BookingStatus;
+/** One of the signed-in contact's bookings. */
+interface PortalBooking {
+    booking_id: string;
+    status: PortalBookingStatus;
+    /** Unix timestamp in milliseconds. */
+    start_ts: number;
+    /** Unix timestamp in milliseconds. */
+    end_ts: number;
+    service_id: string | null;
+    service_name: string | null;
+    resource_id: string | null;
+    resource_name: string | null;
+    booked_for_name: string | null;
+    /** Integer øre, or `null` when the service has no price. */
+    amount_ore: number | null;
+    notes: string | null;
+    /** Present only while the booking is upcoming and manageable; opens the site's manage page. */
+    manage_token: string | null;
+    can_manage: boolean;
+}
+/** The signed-in contact's bookings, split around now. */
+interface PortalBookings {
+    upcoming: PortalBooking[];
+    past: PortalBooking[];
+}
+/** A consent decision included in a portal data export. */
+interface PortalConsentRecord {
+    consent_type: string;
+    granted: boolean;
+    /** Unix timestamp in milliseconds, or `null`. */
+    granted_at: number | null;
+    /** Unix timestamp in milliseconds, or `null`. */
+    revoked_at: number | null;
+    source: string;
+}
+/** Everything the workspace holds about the signed-in contact (GDPR Art. 15). */
+interface PortalExport {
+    /** Unix timestamp in milliseconds. */
+    exported_at: number;
+    contact: PortalProfile;
+    family: PortalFamilyMember[];
+    consents: PortalConsentRecord[];
+    bookings: PortalBooking[];
+}
+
+/**
+ * E-mail one-time-code login.
+ *
+ * Both routes are plain POSTs — deliberately not idempotency-keyed. A start
+ * that is retried sends at most one more code, and a verify that is retried
+ * meets a code that has already been burned and answers
+ * `PORTAL_CODE_INVALID` — neither can duplicate anything.
+ */
+declare class PortalLogin {
+    private client;
+    constructor(client: BaseClient);
+    /**
+     * E-mail a one-time code to the address.
+     *
+     * Always 202 `{ status: "sent" }` — enumeration-safe: `"sent"` does not
+     * confirm that the address belongs to a contact. Rate-limited per address
+     * and per caller (`429 RATE_LIMITED`).
+     */
+    start(input: PortalLoginStartInput): Promise<ApiResponse<PortalLoginStartResult>>;
+    /**
+     * Exchange the e-mailed code for a session.
+     *
+     * `session_token` is a bearer credential for ONE contact — keep it in an
+     * HttpOnly cookie on the site's server. 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.
+     */
+    verify(input: PortalVerifyInput): Promise<ApiResponse<PortalSession>>;
+}
+/**
+ * Customer self-service portal. The session token is a bearer credential for a
+ * single contact: the calling site server must keep it in an HttpOnly cookie
+ * and never hand it to the browser. Session-bound methods send it as
+ * `X-Portal-Session`; none of them carries an `Idempotency-Key`.
+ *
+ * The API key needs `read:portal` and `write:portal` (`403 FORBIDDEN`
+ * otherwise). A missing header answers `401 PORTAL_SESSION_REQUIRED`; an
+ * unknown, expired or revoked token answers `401 PORTAL_SESSION_INVALID` —
+ * treat both as "sign in again".
+ */
+declare class Portal {
+    private client;
+    /** E-mail one-time-code login: `start` sends the code, `verify` exchanges it. */
+    readonly login: PortalLogin;
+    constructor(client: BaseClient);
+    /**
+     * Revoke the session. Resolves to `undefined` (the route answers 204).
+     *
+     * Not keyed: revoking twice reaches the same state — the second call answers
+     * `401 PORTAL_SESSION_INVALID`, which is the outcome you wanted anyway.
+     */
+    logout(session: string): Promise<void>;
+    /** The signed-in contact's own profile. */
+    me(session: string): Promise<ApiResponse<PortalProfile>>;
+    /**
+     * Update the signed-in contact's profile. Only the supplied fields change;
+     * `phone: null` clears the number and `family` replaces the whole list.
+     * `marketing_consent` records a `marketing_email` consent decision with
+     * source `portal`. Returns the profile as it is after the change.
+     */
+    /**
+     * A profile patch is not idempotency-keyed on the server and a `marketing_consent`
+     * change records a dated consent event, so a retry after a committed-but-lost
+     * response would repeat that event: sent exactly once, like the other writes.
+     */
+    updateMe(session: string, patch: PortalProfilePatch): Promise<ApiResponse<PortalProfile>>;
+    /**
+     * The contact's bookings split into `upcoming` and `past`. An upcoming
+     * booking that is still inside the workspace's policy windows carries
+     * `manage_token` and `can_manage: true`; use the token to open the site's
+     * manage page (`medal.bookings.manage.*`).
+     */
+    myBookings(session: string): Promise<ApiResponse<PortalBookings>>;
+    /**
+     * Everything the workspace holds about the contact — profile, family,
+     * consents and bookings — as one JSON document (GDPR Art. 15). Synchronous,
+     * unlike `medal.gdpr.requestExport()`, which exports the whole workspace.
+     *
+     * Not keyed: a read-only snapshot, so a retried call costs nothing and
+     * duplicates nothing.
+     */
+    exportMyData(session: string): Promise<ApiResponse<PortalExport>>;
+    /**
+     * Erase the contact (GDPR Art. 17). Resolves to `undefined` (the route
+     * answers 204); the session is revoked as part of the deletion.
+     *
+     * Not keyed: deletion is terminal, so a retry meets a revoked session and
+     * answers `401 PORTAL_SESSION_INVALID` rather than deleting anything else.
+     */
+    deleteMe(session: string): Promise<void>;
+}
+
 /** A post in the workspace (list view). */
 interface Post {
     id: string;
@@ -2382,6 +2602,12 @@ interface MedalOptions {
  *   to_ts: Date.now() + 7 * 86_400_000,
  * });
  *
+ * // Customer portal — e-mail code login, then session-bound self-service.
+ * // Keep `session_token` in an HttpOnly cookie on your server.
+ * await medal.portal.login.start({ email: 'ida@example.com' });
+ * const { data: session } = await medal.portal.login.verify({ email: 'ida@example.com', code: '123456' });
+ * const { data: mine } = await medal.portal.myBookings(session.session_token);
+ *
  * // Contacts, Deals, GDPR, Workspaces
  * const contacts = await medal.contacts.list({ status: 'lead' });
  * const { data: deal } = await medal.deals.create({ title: 'Acme', value: 50000 });
@@ -2398,6 +2624,7 @@ declare class Medal {
     readonly deals: Deals;
     readonly gdpr: Gdpr;
     readonly helpdesk: Helpdesk;
+    readonly portal: Portal;
     readonly posts: Posts;
     readonly scan: Scan;
     readonly webhooks: Webhooks;
@@ -2408,4 +2635,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, 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 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 };

package/dist/src/index.d.ts

@@ -527,7 +527,7 @@ interface ClientConfig {
     timeout: number;
     userAgent: string;
 }
-/** Per-request options for write operations. */
+/** Per-request options. `headers` applies to every verb; the named options only matter on writes. */
 interface RequestOptions {
     /**
      * Idempotency key sent as the `Idempotency-Key` header. Retries with the
@@ -560,6 +560,22 @@ interface RequestOptions {
      * Ignored on routes that do not require a capability confirmation.
      */
     autoConfirm?: AutoConfirmOptions | false;
+    /**
+     * Set to `false` to send the request exactly once — no automatic retry on
+     * 429/5xx. Use it for writes whose FIRST attempt may have succeeded even
+     * though the response was lost: a one-time code that is burned on use, a
+     * logout or erasure that revokes the very credential a retry would present.
+     * A retry there does not repeat the operation, it misreports it as failed.
+     * Defaults to `true`.
+     */
+    retry?: boolean;
+    /**
+     * Extra request headers, e.g. `x-portal-session` for the customer portal.
+     * Applied first: the named options (`idempotencyKey`,
+     * `capabilityConfirmation`) win over a same-named entry here, so a bag can
+     * never smuggle in a key the SDK did not resolve.
+     */
+    headers?: Record<string, string>;
 }
 /**
  * Low-level HTTP client used by all resource classes.
@@ -570,7 +586,7 @@ declare class BaseClient {
     readonly config: ClientConfig;
     constructor(config: ClientConfig);
     /** Execute an authenticated GET request and return the parsed JSON body. */
-    get<T>(path: string, params?: Record<string, string | undefined>): Promise<T>;
+    get<T>(path: string, params?: Record<string, string | undefined>, options?: Pick<RequestOptions, "headers">): Promise<T>;
     /** Execute an authenticated POST request with a JSON body. */
     post<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
     /**
@@ -1732,6 +1748,210 @@ declare class Helpdesk {
     constructor(client: BaseClient, confirmer?: CapabilityConfirmer);
 }
 
+/** Input for starting an e-mail one-time-code login. */
+interface PortalLoginStartInput {
+    /** The address the code is sent to. */
+    email: string;
+    /** Locale for the e-mail (e.g. `nb`, `en`); the workspace default when omitted. */
+    locale?: string;
+}
+/**
+ * Result of a login start. Always `"sent"`, whether or not the address is a
+ * known contact — the route is enumeration-safe by design.
+ */
+interface PortalLoginStartResult {
+    status: "sent";
+}
+/** Input for exchanging an e-mailed code for a portal session. */
+interface PortalVerifyInput {
+    /** The address the code was sent to. */
+    email: string;
+    /** The one-time code from the e-mail. */
+    code: string;
+}
+/** The contact a portal session belongs to. */
+interface PortalContactSummary {
+    contact_id: string;
+    first_name: string | null;
+}
+/**
+ * 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.
+ */
+interface PortalSession {
+    session_token: string;
+    /** Unix timestamp in milliseconds. */
+    expires_at: number;
+    contact: PortalContactSummary;
+}
+/** A family member the contact books on behalf of. */
+interface PortalFamilyMember {
+    name: string;
+    birth_year: number;
+}
+/** The signed-in contact's own profile. */
+interface PortalProfile {
+    contact_id: string;
+    email: string;
+    first_name: string | null;
+    last_name: string | null;
+    phone: string | null;
+    family: PortalFamilyMember[];
+    marketing_consent: boolean;
+    /** Unix timestamp in milliseconds. */
+    created_at: number;
+}
+/** Fields the signed-in contact may change on their own profile. */
+interface PortalProfilePatch {
+    first_name?: string;
+    last_name?: string;
+    /** `null` clears the number. */
+    phone?: string | null;
+    /** Replaces the whole list. */
+    family?: PortalFamilyMember[];
+    /** Records a marketing_email consent change with source 'portal'. */
+    marketing_consent?: boolean;
+}
+/** Lifecycle state of a booking as seen from the portal. */
+type PortalBookingStatus = BookingStatus;
+/** One of the signed-in contact's bookings. */
+interface PortalBooking {
+    booking_id: string;
+    status: PortalBookingStatus;
+    /** Unix timestamp in milliseconds. */
+    start_ts: number;
+    /** Unix timestamp in milliseconds. */
+    end_ts: number;
+    service_id: string | null;
+    service_name: string | null;
+    resource_id: string | null;
+    resource_name: string | null;
+    booked_for_name: string | null;
+    /** Integer øre, or `null` when the service has no price. */
+    amount_ore: number | null;
+    notes: string | null;
+    /** Present only while the booking is upcoming and manageable; opens the site's manage page. */
+    manage_token: string | null;
+    can_manage: boolean;
+}
+/** The signed-in contact's bookings, split around now. */
+interface PortalBookings {
+    upcoming: PortalBooking[];
+    past: PortalBooking[];
+}
+/** A consent decision included in a portal data export. */
+interface PortalConsentRecord {
+    consent_type: string;
+    granted: boolean;
+    /** Unix timestamp in milliseconds, or `null`. */
+    granted_at: number | null;
+    /** Unix timestamp in milliseconds, or `null`. */
+    revoked_at: number | null;
+    source: string;
+}
+/** Everything the workspace holds about the signed-in contact (GDPR Art. 15). */
+interface PortalExport {
+    /** Unix timestamp in milliseconds. */
+    exported_at: number;
+    contact: PortalProfile;
+    family: PortalFamilyMember[];
+    consents: PortalConsentRecord[];
+    bookings: PortalBooking[];
+}
+
+/**
+ * E-mail one-time-code login.
+ *
+ * Both routes are plain POSTs — deliberately not idempotency-keyed. A start
+ * that is retried sends at most one more code, and a verify that is retried
+ * meets a code that has already been burned and answers
+ * `PORTAL_CODE_INVALID` — neither can duplicate anything.
+ */
+declare class PortalLogin {
+    private client;
+    constructor(client: BaseClient);
+    /**
+     * E-mail a one-time code to the address.
+     *
+     * Always 202 `{ status: "sent" }` — enumeration-safe: `"sent"` does not
+     * confirm that the address belongs to a contact. Rate-limited per address
+     * and per caller (`429 RATE_LIMITED`).
+     */
+    start(input: PortalLoginStartInput): Promise<ApiResponse<PortalLoginStartResult>>;
+    /**
+     * Exchange the e-mailed code for a session.
+     *
+     * `session_token` is a bearer credential for ONE contact — keep it in an
+     * HttpOnly cookie on the site's server. 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.
+     */
+    verify(input: PortalVerifyInput): Promise<ApiResponse<PortalSession>>;
+}
+/**
+ * Customer self-service portal. The session token is a bearer credential for a
+ * single contact: the calling site server must keep it in an HttpOnly cookie
+ * and never hand it to the browser. Session-bound methods send it as
+ * `X-Portal-Session`; none of them carries an `Idempotency-Key`.
+ *
+ * The API key needs `read:portal` and `write:portal` (`403 FORBIDDEN`
+ * otherwise). A missing header answers `401 PORTAL_SESSION_REQUIRED`; an
+ * unknown, expired or revoked token answers `401 PORTAL_SESSION_INVALID` —
+ * treat both as "sign in again".
+ */
+declare class Portal {
+    private client;
+    /** E-mail one-time-code login: `start` sends the code, `verify` exchanges it. */
+    readonly login: PortalLogin;
+    constructor(client: BaseClient);
+    /**
+     * Revoke the session. Resolves to `undefined` (the route answers 204).
+     *
+     * Not keyed: revoking twice reaches the same state — the second call answers
+     * `401 PORTAL_SESSION_INVALID`, which is the outcome you wanted anyway.
+     */
+    logout(session: string): Promise<void>;
+    /** The signed-in contact's own profile. */
+    me(session: string): Promise<ApiResponse<PortalProfile>>;
+    /**
+     * Update the signed-in contact's profile. Only the supplied fields change;
+     * `phone: null` clears the number and `family` replaces the whole list.
+     * `marketing_consent` records a `marketing_email` consent decision with
+     * source `portal`. Returns the profile as it is after the change.
+     */
+    /**
+     * A profile patch is not idempotency-keyed on the server and a `marketing_consent`
+     * change records a dated consent event, so a retry after a committed-but-lost
+     * response would repeat that event: sent exactly once, like the other writes.
+     */
+    updateMe(session: string, patch: PortalProfilePatch): Promise<ApiResponse<PortalProfile>>;
+    /**
+     * The contact's bookings split into `upcoming` and `past`. An upcoming
+     * booking that is still inside the workspace's policy windows carries
+     * `manage_token` and `can_manage: true`; use the token to open the site's
+     * manage page (`medal.bookings.manage.*`).
+     */
+    myBookings(session: string): Promise<ApiResponse<PortalBookings>>;
+    /**
+     * Everything the workspace holds about the contact — profile, family,
+     * consents and bookings — as one JSON document (GDPR Art. 15). Synchronous,
+     * unlike `medal.gdpr.requestExport()`, which exports the whole workspace.
+     *
+     * Not keyed: a read-only snapshot, so a retried call costs nothing and
+     * duplicates nothing.
+     */
+    exportMyData(session: string): Promise<ApiResponse<PortalExport>>;
+    /**
+     * Erase the contact (GDPR Art. 17). Resolves to `undefined` (the route
+     * answers 204); the session is revoked as part of the deletion.
+     *
+     * Not keyed: deletion is terminal, so a retry meets a revoked session and
+     * answers `401 PORTAL_SESSION_INVALID` rather than deleting anything else.
+     */
+    deleteMe(session: string): Promise<void>;
+}
+
 /** A post in the workspace (list view). */
 interface Post {
     id: string;
@@ -2382,6 +2602,12 @@ interface MedalOptions {
  *   to_ts: Date.now() + 7 * 86_400_000,
  * });
  *
+ * // Customer portal — e-mail code login, then session-bound self-service.
+ * // Keep `session_token` in an HttpOnly cookie on your server.
+ * await medal.portal.login.start({ email: 'ida@example.com' });
+ * const { data: session } = await medal.portal.login.verify({ email: 'ida@example.com', code: '123456' });
+ * const { data: mine } = await medal.portal.myBookings(session.session_token);
+ *
  * // Contacts, Deals, GDPR, Workspaces
  * const contacts = await medal.contacts.list({ status: 'lead' });
  * const { data: deal } = await medal.deals.create({ title: 'Acme', value: 50000 });
@@ -2398,6 +2624,7 @@ declare class Medal {
     readonly deals: Deals;
     readonly gdpr: Gdpr;
     readonly helpdesk: Helpdesk;
+    readonly portal: Portal;
     readonly posts: Posts;
     readonly scan: Scan;
     readonly webhooks: Webhooks;
@@ -2408,4 +2635,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, 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 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 };