@curviate/sdk 0.32.0 → 0.34.0

package/CHANGELOG.md

@@ -7,6 +7,82 @@ Versioning: semantic. Minor for additive changes, patch for bug fixes; no stabil
 
 ---
 
+## [0.34.0] - 2026-09-18
+
+Fixture and types regenerated against the deployed production document
+(`https://api.curviate.com`, 127 paths, server `dc4d3d9f0cce8159d7b6685a93291d71eec488c8`).
+
+### Fixed
+
+- **Ordinary-message subject retention copy corrected.** The served subject
+  description previously read "...The InMail subject line, when the platform
+  carries one on this message. Ordinary messages have none. ...", which a live
+  round-trip disproved: a classic `start_chat` to a FIRST_DEGREE contact, sent
+  with a subject, reads it back on `message.specifics.subject` and stores it
+  on both sides. The description now reads "The message's subject line, when
+  the platform carries one on this message. Typically an InMail opener, but an
+  ordinary message sent with a subject carries one too. ...". No type shape
+  change: description string only, at the three sites the served document
+  carries it.
+
+## [0.33.0] - 2026-09-17
+
+The InMail subject on the message reads, now typed. Fixture and types
+regenerated against the deployed production document
+(`https://api.curviate.com`, 127 paths, server `a38f685e`); the exact source
+commit is recorded in `fixtures/PROVENANCE.json`.
+
+### Added
+
+- **`MessageDetail["specifics"]`** types as `{ subject?: string | null }`, on
+  `messaging.getMessage()` and each item of `messaging.listMessages()`. The
+  served object is narrowed to `subject` alone (`additionalProperties: false`).
+  `getChat()`, `listChats()` and `inboxes.listChats()` carry no `specifics` on
+  their embedded `last_message`.
+
+### Changed
+
+- **`recruiter.startChat()` `follow_up.subject` retention copy corrected.** It
+  previously read "Never stored and never logged, on any path", which is not
+  supportable: a Recruiter follow-up is an InMail, so once sent it lands in the
+  classic InMail inbox that the chat reads harvest. The served document now
+  states the conditional, and the regenerated types and fixture carry it.
+- **`messages.sendInmail()` `text`** and the `last_message` descriptions on the
+  chat reads carry the same corrected retention wording.
+
+### Documented
+
+- **`messaging.listMessages()` / `messaging.getMessage()`**: an InMail thread's
+  subject line arrives on a message as `specifics.subject`, set on the thread's
+  opening message. The chat object carries no subject at all, and `chat.name` is
+  the counterpart's display name, so the subject is read off the first message
+  and not off the chat. An ordinary message returns `specifics: {}`. The served
+  `specifics` object is narrowed to `subject` alone.
+- **`messaging.getChat()` / `listChats()` / `inboxes.listChats()`**: a chat read
+  carries no subject anywhere, its embedded `last_message` included. The preview
+  is deliberately narrower than a message read so that a chat read returns the
+  same fields whether it was answered live or from Curviate's stored copy. Read
+  the chat's messages to get a subject.
+
+### Fixture drift swept in by the refresh
+
+The refresh also picked up already-deployed drift the previous fixture lagged
+(it was captured from staging `c98d526`, 2026-09-15). All of it is real served
+state, verified against both `api.curviate.com` and `api.staging.curviate.com`:
+
+- Error-response `examples` blocks removed on **144** operations (343 response
+  slots), on status codes 409, 422, 503 and 504 only. This is server commit
+  `57afde5c5`, "error examples use only codes the API emits", which landed
+  immediately after the previous fixture's base. The earlier estimate of ~38
+  operations undercounted.
+- Prose corrections to a handful of already-served descriptions: the 503 on the
+  applicant-résumé read now names its code, the Sales Navigator chat 422 names
+  only the code it emits, the auth-intent 402 describes both codes it can
+  carry, and the safety-policy descriptions drop raw path templates and say
+  "tenant" rather than "workspace".
+
+---
+
 ## [0.32.0] - 2026-09-15
 
 Seat discovery for connecting an account. Additive; nothing removed or renamed.

package/dist/index.d.ts

@@ -847,7 +847,7 @@ interface paths {
         put?: never;
         /**
          * Start a chat
-         * @description Starts a new chat with one or more members from a connected account. Send application/json; attach files as base64-encoded attachments (max 5 MiB per file, and 9 MiB for the whole request body; base64 makes a file about a third larger in the body than on disk). Message content passes through to the platform and is never stored. Company pages are reply-only and cannot start a conversation; reply using a `COMPANY_` chat id from GET /v1/{account_id}/inboxes/{inbox_id}/chats instead.
+         * @description Starts a new chat with one or more members from a connected account. Send application/json; attach files as base64-encoded attachments (max 5 MiB per file, and 9 MiB for the whole request body; base64 makes a file about a third larger in the body than on disk). This call keeps nothing and logs nothing. Once sent it is a message in the account's inbox, so reading that conversation back through Curviate stores its body in your tenant's inbox records, with no expiry. Company pages are reply-only and cannot start a conversation; reply using a `COMPANY_` chat id from GET /v1/{account_id}/inboxes/{inbox_id}/chats instead.
          */
         post: operations["postV1AccountIdChats"];
         delete?: never;
@@ -895,7 +895,7 @@ interface paths {
         put?: never;
         /**
          * Send a message
-         * @description Sends a message into an existing chat. Send application/json with text, base64 attachments (max 5 MiB per file, and 9 MiB for the whole request body; base64 makes a file about a third larger in the body than on disk), or both; at least one of text or attachments is required. Message content passes through to the platform and is never stored. Sending on behalf of a company page: use a COMPANY_ chat id (from GET /v1/{account_id}/inboxes/{inbox_id}/chats) and the message sends AS THE PAGE, no separate parameter needed. The response's sent_as field names the acting identity that was actually used. Company pages are reply-only: this endpoint can answer an existing conversation on a page's behalf, but a page can never start a new one.
+         * @description Sends a message into an existing chat. Send application/json with text, base64 attachments (max 5 MiB per file, and 9 MiB for the whole request body; base64 makes a file about a third larger in the body than on disk), or both; at least one of text or attachments is required. This call keeps nothing and logs nothing. Once sent it is a message in the account's inbox, so reading that conversation back through Curviate stores its body in your tenant's inbox records, with no expiry. Sending on behalf of a company page: use a COMPANY_ chat id (from GET /v1/{account_id}/inboxes/{inbox_id}/chats) and the message sends AS THE PAGE, no separate parameter needed. The response's sent_as field names the acting identity that was actually used. Company pages are reply-only: this endpoint can answer an existing conversation on a page's behalf, but a page can never start a new one.
          */
         post: operations["postV1AccountIdChatsChatIdMessages"];
         delete?: never;
@@ -2885,7 +2885,7 @@ interface components {
             chat_id?: string;
             /** @description Identifier of the sender. */
             sender_id?: string;
-            /** @description Full message text (content pass-through, never stored). */
+            /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
             text?: string | null;
             /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
             attachments?: {
@@ -2920,6 +2920,11 @@ interface components {
             reaction_count?: number;
             /** @description The platform this message originates from. */
             provider?: string;
+            /** @description Platform-specific detail on the message. Carries `subject` for an InMail, which is set on the thread's opening message; absent or empty for an ordinary message. */
+            specifics?: {
+                /** @description The message's subject line, when the platform carries one on this message. Typically an InMail opener, but an ordinary message sent with a subject carries one too. Reading a conversation back stores the subject in your tenant's inbox records alongside the body, with no expiry. */
+                subject?: string | null;
+            };
             /** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
             sender?: {
                 /** @description Identifier of the counterpart. */
@@ -10336,7 +10341,7 @@ interface operations {
                             last_message_timestamp?: string;
                             /** @description Identifier of the 1:1 counterpart. */
                             user_id?: string;
-                            /** @description The most recent message in the chat. */
+                            /** @description The most recent message in the chat. Subjects are not previewed here, read the chat's messages for one. */
                             last_message?: {
                                 /**
                                  * @description Response type discriminator.
@@ -10352,7 +10357,7 @@ interface operations {
                                 chat_id?: string;
                                 /** @description Identifier of the sender. */
                                 sender_id?: string;
-                                /** @description Full message text (content pass-through, never stored). */
+                                /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                                 text?: string | null;
                                 /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                                 attachments?: {
@@ -10761,7 +10766,7 @@ interface operations {
                         last_message_timestamp?: string;
                         /** @description Identifier of the 1:1 counterpart. */
                         user_id?: string;
-                        /** @description The most recent message in the chat. */
+                        /** @description The most recent message in the chat. Subjects are not previewed here, read the chat's messages for one. */
                         last_message?: {
                             /**
                              * @description Response type discriminator.
@@ -10777,7 +10782,7 @@ interface operations {
                             chat_id?: string;
                             /** @description Identifier of the sender. */
                             sender_id?: string;
-                            /** @description Full message text (content pass-through, never stored). */
+                            /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                             text?: string | null;
                             /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                             attachments?: {
@@ -11147,7 +11152,7 @@ interface operations {
                             chat_id?: string;
                             /** @description Identifier of the sender. */
                             sender_id?: string;
-                            /** @description Full message text (content pass-through, never stored). */
+                            /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                             text?: string | null;
                             /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                             attachments?: {
@@ -11182,6 +11187,11 @@ interface operations {
                             reaction_count?: number;
                             /** @description The platform this message originates from. */
                             provider?: string;
+                            /** @description Platform-specific detail on the message. Carries `subject` for an InMail, which is set on the thread's opening message; absent or empty for an ordinary message. */
+                            specifics?: {
+                                /** @description The message's subject line, when the platform carries one on this message. Typically an InMail opener, but an ordinary message sent with a subject carries one too. Reading a conversation back stores the subject in your tenant's inbox records alongside the body, with no expiry. */
+                                subject?: string | null;
+                            };
                             /** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
                             sender?: {
                                 /** @description Identifier of the counterpart. */
@@ -11526,7 +11536,7 @@ interface operations {
                         chat_id?: string;
                         /** @description Identifier of the sender. */
                         sender_id?: string;
-                        /** @description Full message text (content pass-through, never stored). */
+                        /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                         text?: string | null;
                         /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                         attachments?: {
@@ -11561,6 +11571,11 @@ interface operations {
                         reaction_count?: number;
                         /** @description The platform this message originates from. */
                         provider?: string;
+                        /** @description Platform-specific detail on the message. Carries `subject` for an InMail, which is set on the thread's opening message; absent or empty for an ordinary message. */
+                        specifics?: {
+                            /** @description The message's subject line, when the platform carries one on this message. Typically an InMail opener, but an ordinary message sent with a subject carries one too. Reading a conversation back stores the subject in your tenant's inbox records alongside the body, with no expiry. */
+                            subject?: string | null;
+                        };
                         /** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
                         sender?: {
                             /** @description Identifier of the counterpart. */
@@ -12218,7 +12233,7 @@ interface operations {
                                 id?: string;
                                 /** @description Account id that owns this message. */
                                 account_id?: string;
-                                /** @description Full message text (content pass-through, never stored). */
+                                /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                                 text?: string | null;
                                 /** @description Identifier of the sender. */
                                 sender_id?: string;
@@ -12357,7 +12372,7 @@ interface operations {
                     recipient_urn: string;
                     /** @description InMail subject line (1-200 chars). */
                     subject: string;
-                    /** @description InMail body text (1-8000 chars). */
+                    /** @description InMail body text (1-8000 chars). This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                     text: string;
                 };
             };
@@ -12700,7 +12715,7 @@ interface operations {
                             last_message_timestamp?: string;
                             /** @description Identifier of the 1:1 counterpart. */
                             user_id?: string;
-                            /** @description The most recent message in the chat. */
+                            /** @description The most recent message in the chat. Subjects are not previewed here, read the chat's messages for one. */
                             last_message?: {
                                 /**
                                  * @description Response type discriminator.
@@ -12716,7 +12731,7 @@ interface operations {
                                 chat_id?: string;
                                 /** @description Identifier of the sender. */
                                 sender_id?: string;
-                                /** @description Full message text (content pass-through, never stored). */
+                                /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                                 text?: string | null;
                                 /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                                 attachments?: {
@@ -17974,7 +17989,7 @@ interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description The résumé is still being generated and was not ready in time. Retry the request shortly. */
+            /** @description LINKEDIN_SERVICE_UNAVAILABLE, the résumé is still being generated and was not ready in time. Retry the request shortly. */
             503: {
                 headers: {
                     [name: string]: unknown;
@@ -20180,11 +20195,11 @@ interface operations {
                 "application/json": {
                     /** @description One or more Recruiter member IDs (AE... format) to include in the chat. */
                     attendees_ids: string[];
-                    /** @description Opening message text (1-8000 chars). Passed to the platform and discarded; never stored or logged. */
+                    /** @description Opening message text (1-8000 chars). This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                     text: string;
                     /** @description Subject line; REQUIRED for Recruiter (InMail-based messaging), unlike the classic surface (<= 200 chars). */
                     subject: string;
-                    /** @description Sender signature; REQUIRED for Recruiter. Not stored or logged. */
+                    /** @description Sender signature; REQUIRED for Recruiter. Kept as a field by neither this call nor the log. The platform renders it into the sent message body, which is stored if that chat is later read back through Curviate. */
                     signature: string;
                     /**
                      * @description Visibility of the recruiter chat.
@@ -20203,11 +20218,11 @@ interface operations {
                     send_as?: "INMAIL" | "EMAIL";
                     /** @description Sourcing channel for tracking purposes (e.g. CAREER_SITE, MANUAL_IMPORT, INTERNAL_CANDIDATES, RECRUITER_SEARCH, REFERRAL; the vendor's own vocabulary is broader than this illustrative set, so any non-empty value is accepted rather than a closed enum). */
                     channel_type?: string;
-                    /** @description Recruiter PRO only: schedule a follow-up message. subject/text are not stored or logged. */
+                    /** @description Recruiter PRO only: schedule a follow-up message. subject: This call keeps nothing and logs nothing, and unlike the message body the platform does not render it into what is sent. Once sent it is an InMail in the account's inbox: if a message read surfaces this subject, reading that chat back stores it in your tenant's inbox records like a body, with no expiry. text: This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                     follow_up?: {
-                        /** @description Follow-up message subject. Not stored or logged. */
+                        /** @description Follow-up message subject. This call keeps nothing and logs nothing, and unlike the message body the platform does not render it into what is sent. Once sent it is an InMail in the account's inbox: if a message read surfaces this subject, reading that chat back stores it in your tenant's inbox records like a body, with no expiry. */
                         subject: string;
-                        /** @description Follow-up message body. Not stored or logged. */
+                        /** @description Follow-up message body. This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                         text: string;
                         /** @description Optional follow-up attachments. */
                         attachments?: {
@@ -24850,7 +24865,7 @@ interface operations {
                 "application/json": {
                     /** @description Sales Navigator member IDs for the chat recipients (>= 1, e.g. ACw...). */
                     attendees_ids: string[];
-                    /** @description Opening message text (1-8000 chars). Not stored or logged. */
+                    /** @description Opening message text (1-8000 chars). This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                     text: string;
                     /** @description Subject line; REQUIRED for Sales Navigator (InMail-based messaging), unlike the classic surface where it is optional (<= 200 chars). Maps into the SN-only specifics branch. */
                     subject: string;
@@ -24954,7 +24969,7 @@ interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description RECIPIENT_UNREACHABLE or ACCOUNT_RESTRICTED, the recipient cannot be messaged or the account is restricted. */
+            /** @description ACCOUNT_RESTRICTED, the connected LinkedIn account cannot perform this operation. */
             422: {
                 headers: {
                     [name: string]: unknown;
@@ -28642,7 +28657,7 @@ interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description Payment required, an active subscription / seat is needed. */
+            /** @description Either PAYMENT_REQUIRED (an active subscription / seat is needed; update your payment method or purchase a seat) or ACCOUNT_DISPUTED (the tenant's account is under dispute review; contact support). The code field distinguishes the two. */
             402: {
                 headers: {
                     [name: string]: unknown;
@@ -30753,14 +30768,14 @@ interface operations {
             content: {
                 "application/json": {
                     /**
-                     * @description Which set of Curviate defaults this account's rows resolve from: `basic`, `premium`, `sales_navigator` or `recruiter`. Each inherits the one before it and raises a few rows. This is the platform product active on the account, NOT the Curviate seat entitlement, and the two can disagree: a lapsed subscription leaves the seat untouched. Curviate detects it from the platform when the account connects, re-detects it on every reconnect and, at most once a day, on an account read; setting it here is an operator override of that result and holds until the next connect. To undo the override, send `limit_profile_source: "default"`: the pin is released, and Curviate re-reads the value from LinkedIn on the account's next read or connect. Sending the value the account already holds changes nothing and pins nothing. The change is recorded in the ledger and it moves the defaults under every row at once, so any row you have configured explicitly keeps your value. The elevated Sales Navigator and Recruiter figures apply only to calls made through the matching interface, the `/v1/{account_id}/sales-navigator/...` and `/v1/{account_id}/recruiter/...` operations, and Curviate holds each call to the figure for the interface it goes through. The numbers here are therefore the ones a standard-interface call is held to, on every profile; a call through one of those operations resolves from the elevated set instead, and each row publishes that figure as `interface_ceiling`.
+                     * @description Which set of Curviate defaults this account's rows resolve from: `basic`, `premium`, `sales_navigator` or `recruiter`. Each inherits the one before it and raises a few rows. This is the platform product active on the account, NOT the Curviate seat entitlement, and the two can disagree: a lapsed subscription leaves the seat untouched. Curviate detects it from the platform when the account connects, re-detects it on every reconnect and, at most once a day, on an account read; setting it here is an operator override of that result and holds until the next connect. To undo the override, send `limit_profile_source: "default"`: the pin is released, and Curviate re-reads the value from LinkedIn on the account's next read or connect. Sending the value the account already holds changes nothing and pins nothing. The change is recorded in the ledger and it moves the defaults under every row at once, so any row you have configured explicitly keeps your value. The elevated Sales Navigator and Recruiter figures apply only to calls made through the matching interface, the Sales Navigator and Recruiter operations, and Curviate holds each call to the figure for the interface it goes through. The numbers here are therefore the ones a standard-interface call is held to, on every profile; a call through one of those operations resolves from the elevated set instead, and each row publishes that figure as `interface_ceiling`.
                      * @enum {string}
                      */
                     limit_profile?: "basic" | "premium" | "sales_navigator" | "recruiter";
                     /** @description The IANA zone this account's ACTIVITY window is read in, e.g. `Europe/Berlin`. Must be a real zone; anything else is a 400. Null clears it, which DISABLES the activity window for every row that has not set its own: a guessed zone inverts the window, which is worse than not having one. */
                     timezone?: string | null;
                     /**
-                     * @description The tenant-wide posture default, which every account inherits unless it overrides it. Set it once for a whole workspace of personas. Null clears it back to `warn`.
+                     * @description The tenant-wide posture default, which every account inherits unless it overrides it. Set it once for a whole tenant of personas. Null clears it back to `warn`.
                      * @enum {string|null}
                      */
                     tenant_default_posture?: "warn" | "enforce" | null;
@@ -30829,7 +30844,7 @@ interface operations {
                         source_class?: "substrate" | "linkedin_official" | "practitioner" | "inferred" | "unseeded" | null;
                         /** @description READ-ONLY. `ceiling` with the account's warm-up ramp applied, which is what this row is actually held to. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                         effective_ceiling?: unknown;
-                        /** @description READ-ONLY. What a call through the matching elevated interface (`/v1/{account_id}/sales-navigator/...`, `/v1/{account_id}/recruiter/...`) is held to on this row, or null when this row and limit profile have no such figure. `ceiling`, `effective_ceiling`, `band` and `over_default` are all the STANDARD-interface figure, so on a `sales_navigator` or `recruiter` account a row can report `over` while a call through the elevated interface still succeeds. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
+                        /** @description READ-ONLY. What a call through the matching elevated interface (the Sales Navigator and Recruiter operations) is held to on this row, or null when this row and limit profile have no such figure. `ceiling`, `effective_ceiling`, `band` and `over_default` are all the STANDARD-interface figure, so on a `sales_navigator` or `recruiter` account a row can report `over` while a call through the elevated interface still succeeds. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                         interface_ceiling?: unknown;
                         /** @description READ-ONLY. `interface_ceiling` with the account's warm-up ramp applied. Read THIS to know where an elevated-interface call stops, for the same reason `effective_ceiling` and not `ceiling` answers that for a standard one. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                         effective_interface_ceiling?: unknown;
@@ -31344,7 +31359,7 @@ interface operations {
                              * @enum {string|null}
                              */
                             source_class?: "substrate" | "linkedin_official" | "practitioner" | "inferred" | "unseeded" | null;
-                            /** @description READ-ONLY. What a call through the matching elevated interface (`/v1/{account_id}/sales-navigator/...`, `/v1/{account_id}/recruiter/...`) is held to on this row, or null when this row and limit profile have no such figure. `ceiling`, `effective_ceiling`, `band` and `over_default` are all the STANDARD-interface figure, so on a `sales_navigator` or `recruiter` account a row can report `over` while a call through the elevated interface still succeeds. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
+                            /** @description READ-ONLY. What a call through the matching elevated interface (the Sales Navigator and Recruiter operations) is held to on this row, or null when this row and limit profile have no such figure. `ceiling`, `effective_ceiling`, `band` and `over_default` are all the STANDARD-interface figure, so on a `sales_navigator` or `recruiter` account a row can report `over` while a call through the elevated interface still succeeds. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                             interface_ceiling?: unknown;
                             /** @description READ-ONLY. The fields on this row configured above the Curviate default. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                             over_default?: unknown;
@@ -31833,6 +31848,19 @@ declare class MessagingResource {
     /**
      * List messages in a chat, cursor-paginated.
      * `GET /v1/{account_id}/chats/{chat_id}/messages`
+     *
+     * An InMail thread's subject line arrives on a MESSAGE, as
+     * `message.specifics.subject`, carried by the thread's opening message. The
+     * chat object has no subject of its own, and `chat.name` is the counterpart's
+     * display name rather than a folded-in subject, so read the subject from the
+     * first message rather than from the chat. Ordinary (non-InMail) messages
+     * return `specifics: {}`.
+     *
+     * A CHAT READ CARRIES NO SUBJECT AT ALL, including on its embedded
+     * `last_message`: the preview is deliberately narrower than a message read, so
+     * that a chat read returns the same fields whether it was answered from
+     * LinkedIn or from Curviate's stored copy. Getting a subject means reading the
+     * chat's messages.
      */
     listMessages(chatId: string, params?: MessageListQuery): Promise<MessageListPage>;
     /**
@@ -31867,6 +31895,11 @@ declare class MessagingResource {
     /**
      * Get a single message by ID, re-homed under its chat.
      * `GET /v1/{account_id}/chats/{chat_id}/messages/{message_id}`
+     *
+     * `specifics` carries the InMail subject when the platform set one on this
+     * message (`specifics.subject`), and is `{}` otherwise. It is narrowed to
+     * that one field on purpose: the platform's other `specifics` keys are not
+     * part of the published surface.
      */
     getMessage(chatId: string, messageId: string): Promise<MessageDetail>;
     /**
@@ -33631,7 +33664,7 @@ declare class CompaniesResource {
      * const result = await acc.companies.sendMessage("112013061", chats[0]!.id, {
      *   text: "Thanks for reaching out, happy to help!",
      * });
-     * console.log(result.sent_as); // { kind: "company", company_id: "112013061", name: "RedHire" }
+     * console.log(result.sent_as); // { kind: "company", company_id: "112013061", name: "Northwind Talent" }
      */
     sendMessage(identifier: string, chatId: string, body: CompanySendMessageBody): Promise<CompanySendMessageResult>;
 }

package/dist/index.js

@@ -785,6 +785,19 @@ var MessagingResource = class {
   /**
    * List messages in a chat, cursor-paginated.
    * `GET /v1/{account_id}/chats/{chat_id}/messages`
+   *
+   * An InMail thread's subject line arrives on a MESSAGE, as
+   * `message.specifics.subject`, carried by the thread's opening message. The
+   * chat object has no subject of its own, and `chat.name` is the counterpart's
+   * display name rather than a folded-in subject, so read the subject from the
+   * first message rather than from the chat. Ordinary (non-InMail) messages
+   * return `specifics: {}`.
+   *
+   * A CHAT READ CARRIES NO SUBJECT AT ALL, including on its embedded
+   * `last_message`: the preview is deliberately narrower than a message read, so
+   * that a chat read returns the same fields whether it was answered from
+   * LinkedIn or from Curviate's stored copy. Getting a subject means reading the
+   * chat's messages.
    */
   listMessages(chatId, params) {
     return this.ctx.request({
@@ -831,6 +844,11 @@ var MessagingResource = class {
   /**
    * Get a single message by ID, re-homed under its chat.
    * `GET /v1/{account_id}/chats/{chat_id}/messages/{message_id}`
+   *
+   * `specifics` carries the InMail subject when the platform set one on this
+   * message (`specifics.subject`), and is `{}` otherwise. It is narrowed to
+   * that one field on purpose: the platform's other `specifics` keys are not
+   * part of the published surface.
    */
   getMessage(chatId, messageId) {
     return this.ctx.request({
@@ -2811,7 +2829,7 @@ var CompaniesResource = class {
    * const result = await acc.companies.sendMessage("112013061", chats[0]!.id, {
    *   text: "Thanks for reaching out, happy to help!",
    * });
-   * console.log(result.sent_as); // { kind: "company", company_id: "112013061", name: "RedHire" }
+   * console.log(result.sent_as); // { kind: "company", company_id: "112013061", name: "Northwind Talent" }
    */
   sendMessage(identifier, chatId, body) {
     return this.ctx.request({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curviate/sdk",
-  "version": "0.32.0",
+  "version": "0.34.0",
   "private": false,
   "description": "TypeScript SDK for the Curviate API.",
   "license": "MIT",

package/src/generated/types.ts

@@ -749,7 +749,7 @@ export interface paths {
         put?: never;
         /**
          * Start a chat
-         * @description Starts a new chat with one or more members from a connected account. Send application/json; attach files as base64-encoded attachments (max 5 MiB per file, and 9 MiB for the whole request body; base64 makes a file about a third larger in the body than on disk). Message content passes through to the platform and is never stored. Company pages are reply-only and cannot start a conversation; reply using a `COMPANY_` chat id from GET /v1/{account_id}/inboxes/{inbox_id}/chats instead.
+         * @description Starts a new chat with one or more members from a connected account. Send application/json; attach files as base64-encoded attachments (max 5 MiB per file, and 9 MiB for the whole request body; base64 makes a file about a third larger in the body than on disk). This call keeps nothing and logs nothing. Once sent it is a message in the account's inbox, so reading that conversation back through Curviate stores its body in your tenant's inbox records, with no expiry. Company pages are reply-only and cannot start a conversation; reply using a `COMPANY_` chat id from GET /v1/{account_id}/inboxes/{inbox_id}/chats instead.
          */
         post: operations["postV1AccountIdChats"];
         delete?: never;
@@ -797,7 +797,7 @@ export interface paths {
         put?: never;
         /**
          * Send a message
-         * @description Sends a message into an existing chat. Send application/json with text, base64 attachments (max 5 MiB per file, and 9 MiB for the whole request body; base64 makes a file about a third larger in the body than on disk), or both; at least one of text or attachments is required. Message content passes through to the platform and is never stored. Sending on behalf of a company page: use a COMPANY_ chat id (from GET /v1/{account_id}/inboxes/{inbox_id}/chats) and the message sends AS THE PAGE, no separate parameter needed. The response's sent_as field names the acting identity that was actually used. Company pages are reply-only: this endpoint can answer an existing conversation on a page's behalf, but a page can never start a new one.
+         * @description Sends a message into an existing chat. Send application/json with text, base64 attachments (max 5 MiB per file, and 9 MiB for the whole request body; base64 makes a file about a third larger in the body than on disk), or both; at least one of text or attachments is required. This call keeps nothing and logs nothing. Once sent it is a message in the account's inbox, so reading that conversation back through Curviate stores its body in your tenant's inbox records, with no expiry. Sending on behalf of a company page: use a COMPANY_ chat id (from GET /v1/{account_id}/inboxes/{inbox_id}/chats) and the message sends AS THE PAGE, no separate parameter needed. The response's sent_as field names the acting identity that was actually used. Company pages are reply-only: this endpoint can answer an existing conversation on a page's behalf, but a page can never start a new one.
          */
         post: operations["postV1AccountIdChatsChatIdMessages"];
         delete?: never;
@@ -2788,7 +2788,7 @@ export interface components {
             chat_id?: string;
             /** @description Identifier of the sender. */
             sender_id?: string;
-            /** @description Full message text (content pass-through, never stored). */
+            /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
             text?: string | null;
             /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
             attachments?: {
@@ -2823,6 +2823,11 @@ export interface components {
             reaction_count?: number;
             /** @description The platform this message originates from. */
             provider?: string;
+            /** @description Platform-specific detail on the message. Carries `subject` for an InMail, which is set on the thread's opening message; absent or empty for an ordinary message. */
+            specifics?: {
+                /** @description The message's subject line, when the platform carries one on this message. Typically an InMail opener, but an ordinary message sent with a subject carries one too. Reading a conversation back stores the subject in your tenant's inbox records alongside the body, with no expiry. */
+                subject?: string | null;
+            };
             /** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
             sender?: {
                 /** @description Identifier of the counterpart. */
@@ -10240,7 +10245,7 @@ export interface operations {
                             last_message_timestamp?: string;
                             /** @description Identifier of the 1:1 counterpart. */
                             user_id?: string;
-                            /** @description The most recent message in the chat. */
+                            /** @description The most recent message in the chat. Subjects are not previewed here, read the chat's messages for one. */
                             last_message?: {
                                 /**
                                  * @description Response type discriminator.
@@ -10256,7 +10261,7 @@ export interface operations {
                                 chat_id?: string;
                                 /** @description Identifier of the sender. */
                                 sender_id?: string;
-                                /** @description Full message text (content pass-through, never stored). */
+                                /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                                 text?: string | null;
                                 /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                                 attachments?: {
@@ -10665,7 +10670,7 @@ export interface operations {
                         last_message_timestamp?: string;
                         /** @description Identifier of the 1:1 counterpart. */
                         user_id?: string;
-                        /** @description The most recent message in the chat. */
+                        /** @description The most recent message in the chat. Subjects are not previewed here, read the chat's messages for one. */
                         last_message?: {
                             /**
                              * @description Response type discriminator.
@@ -10681,7 +10686,7 @@ export interface operations {
                             chat_id?: string;
                             /** @description Identifier of the sender. */
                             sender_id?: string;
-                            /** @description Full message text (content pass-through, never stored). */
+                            /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                             text?: string | null;
                             /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                             attachments?: {
@@ -11051,7 +11056,7 @@ export interface operations {
                             chat_id?: string;
                             /** @description Identifier of the sender. */
                             sender_id?: string;
-                            /** @description Full message text (content pass-through, never stored). */
+                            /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                             text?: string | null;
                             /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                             attachments?: {
@@ -11086,6 +11091,11 @@ export interface operations {
                             reaction_count?: number;
                             /** @description The platform this message originates from. */
                             provider?: string;
+                            /** @description Platform-specific detail on the message. Carries `subject` for an InMail, which is set on the thread's opening message; absent or empty for an ordinary message. */
+                            specifics?: {
+                                /** @description The message's subject line, when the platform carries one on this message. Typically an InMail opener, but an ordinary message sent with a subject carries one too. Reading a conversation back stores the subject in your tenant's inbox records alongside the body, with no expiry. */
+                                subject?: string | null;
+                            };
                             /** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
                             sender?: {
                                 /** @description Identifier of the counterpart. */
@@ -11430,7 +11440,7 @@ export interface operations {
                         chat_id?: string;
                         /** @description Identifier of the sender. */
                         sender_id?: string;
-                        /** @description Full message text (content pass-through, never stored). */
+                        /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                         text?: string | null;
                         /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                         attachments?: {
@@ -11465,6 +11475,11 @@ export interface operations {
                         reaction_count?: number;
                         /** @description The platform this message originates from. */
                         provider?: string;
+                        /** @description Platform-specific detail on the message. Carries `subject` for an InMail, which is set on the thread's opening message; absent or empty for an ordinary message. */
+                        specifics?: {
+                            /** @description The message's subject line, when the platform carries one on this message. Typically an InMail opener, but an ordinary message sent with a subject carries one too. Reading a conversation back stores the subject in your tenant's inbox records alongside the body, with no expiry. */
+                            subject?: string | null;
+                        };
                         /** @description The sender's profile, when the platform returned one alongside the message. sender_id always carries the identifier; this object carries the rest of what is known about that person. */
                         sender?: {
                             /** @description Identifier of the counterpart. */
@@ -12122,7 +12137,7 @@ export interface operations {
                                 id?: string;
                                 /** @description Account id that owns this message. */
                                 account_id?: string;
-                                /** @description Full message text (content pass-through, never stored). */
+                                /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                                 text?: string | null;
                                 /** @description Identifier of the sender. */
                                 sender_id?: string;
@@ -12261,7 +12276,7 @@ export interface operations {
                     recipient_urn: string;
                     /** @description InMail subject line (1-200 chars). */
                     subject: string;
-                    /** @description InMail body text (1-8000 chars). */
+                    /** @description InMail body text (1-8000 chars). This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                     text: string;
                 };
             };
@@ -12604,7 +12619,7 @@ export interface operations {
                             last_message_timestamp?: string;
                             /** @description Identifier of the 1:1 counterpart. */
                             user_id?: string;
-                            /** @description The most recent message in the chat. */
+                            /** @description The most recent message in the chat. Subjects are not previewed here, read the chat's messages for one. */
                             last_message?: {
                                 /**
                                  * @description Response type discriminator.
@@ -12620,7 +12635,7 @@ export interface operations {
                                 chat_id?: string;
                                 /** @description Identifier of the sender. */
                                 sender_id?: string;
-                                /** @description Full message text (content pass-through, never stored). */
+                                /** @description Full message text. Curviate does not keep it on the way out; reading a conversation back stores its message bodies in your tenant's inbox records, with no expiry. */
                                 text?: string | null;
                                 /** @description Attachment descriptors (no bytes, use the attachment endpoint to download). */
                                 attachments?: {
@@ -17878,7 +17893,7 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description The résumé is still being generated and was not ready in time. Retry the request shortly. */
+            /** @description LINKEDIN_SERVICE_UNAVAILABLE, the résumé is still being generated and was not ready in time. Retry the request shortly. */
             503: {
                 headers: {
                     [name: string]: unknown;
@@ -20084,11 +20099,11 @@ export interface operations {
                 "application/json": {
                     /** @description One or more Recruiter member IDs (AE... format) to include in the chat. */
                     attendees_ids: string[];
-                    /** @description Opening message text (1-8000 chars). Passed to the platform and discarded; never stored or logged. */
+                    /** @description Opening message text (1-8000 chars). This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                     text: string;
                     /** @description Subject line; REQUIRED for Recruiter (InMail-based messaging), unlike the classic surface (<= 200 chars). */
                     subject: string;
-                    /** @description Sender signature; REQUIRED for Recruiter. Not stored or logged. */
+                    /** @description Sender signature; REQUIRED for Recruiter. Kept as a field by neither this call nor the log. The platform renders it into the sent message body, which is stored if that chat is later read back through Curviate. */
                     signature: string;
                     /**
                      * @description Visibility of the recruiter chat.
@@ -20107,11 +20122,11 @@ export interface operations {
                     send_as?: "INMAIL" | "EMAIL";
                     /** @description Sourcing channel for tracking purposes (e.g. CAREER_SITE, MANUAL_IMPORT, INTERNAL_CANDIDATES, RECRUITER_SEARCH, REFERRAL; the vendor's own vocabulary is broader than this illustrative set, so any non-empty value is accepted rather than a closed enum). */
                     channel_type?: string;
-                    /** @description Recruiter PRO only: schedule a follow-up message. subject/text are not stored or logged. */
+                    /** @description Recruiter PRO only: schedule a follow-up message. subject: This call keeps nothing and logs nothing, and unlike the message body the platform does not render it into what is sent. Once sent it is an InMail in the account's inbox: if a message read surfaces this subject, reading that chat back stores it in your tenant's inbox records like a body, with no expiry. text: This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                     follow_up?: {
-                        /** @description Follow-up message subject. Not stored or logged. */
+                        /** @description Follow-up message subject. This call keeps nothing and logs nothing, and unlike the message body the platform does not render it into what is sent. Once sent it is an InMail in the account's inbox: if a message read surfaces this subject, reading that chat back stores it in your tenant's inbox records like a body, with no expiry. */
                         subject: string;
-                        /** @description Follow-up message body. Not stored or logged. */
+                        /** @description Follow-up message body. This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                         text: string;
                         /** @description Optional follow-up attachments. */
                         attachments?: {
@@ -24754,7 +24769,7 @@ export interface operations {
                 "application/json": {
                     /** @description Sales Navigator member IDs for the chat recipients (>= 1, e.g. ACw...). */
                     attendees_ids: string[];
-                    /** @description Opening message text (1-8000 chars). Not stored or logged. */
+                    /** @description Opening message text (1-8000 chars). This call keeps nothing and logs nothing. Once sent it is a message in the account's InMail inbox, so reading that chat back through Curviate stores its body in your tenant's inbox records, with no expiry. */
                     text: string;
                     /** @description Subject line; REQUIRED for Sales Navigator (InMail-based messaging), unlike the classic surface where it is optional (<= 200 chars). Maps into the SN-only specifics branch. */
                     subject: string;
@@ -24858,7 +24873,7 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description RECIPIENT_UNREACHABLE or ACCOUNT_RESTRICTED, the recipient cannot be messaged or the account is restricted. */
+            /** @description ACCOUNT_RESTRICTED, the connected LinkedIn account cannot perform this operation. */
             422: {
                 headers: {
                     [name: string]: unknown;
@@ -28546,7 +28561,7 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description Payment required, an active subscription / seat is needed. */
+            /** @description Either PAYMENT_REQUIRED (an active subscription / seat is needed; update your payment method or purchase a seat) or ACCOUNT_DISPUTED (the tenant's account is under dispute review; contact support). The code field distinguishes the two. */
             402: {
                 headers: {
                     [name: string]: unknown;
@@ -30657,14 +30672,14 @@ export interface operations {
             content: {
                 "application/json": {
                     /**
-                     * @description Which set of Curviate defaults this account's rows resolve from: `basic`, `premium`, `sales_navigator` or `recruiter`. Each inherits the one before it and raises a few rows. This is the platform product active on the account, NOT the Curviate seat entitlement, and the two can disagree: a lapsed subscription leaves the seat untouched. Curviate detects it from the platform when the account connects, re-detects it on every reconnect and, at most once a day, on an account read; setting it here is an operator override of that result and holds until the next connect. To undo the override, send `limit_profile_source: "default"`: the pin is released, and Curviate re-reads the value from LinkedIn on the account's next read or connect. Sending the value the account already holds changes nothing and pins nothing. The change is recorded in the ledger and it moves the defaults under every row at once, so any row you have configured explicitly keeps your value. The elevated Sales Navigator and Recruiter figures apply only to calls made through the matching interface, the `/v1/{account_id}/sales-navigator/...` and `/v1/{account_id}/recruiter/...` operations, and Curviate holds each call to the figure for the interface it goes through. The numbers here are therefore the ones a standard-interface call is held to, on every profile; a call through one of those operations resolves from the elevated set instead, and each row publishes that figure as `interface_ceiling`.
+                     * @description Which set of Curviate defaults this account's rows resolve from: `basic`, `premium`, `sales_navigator` or `recruiter`. Each inherits the one before it and raises a few rows. This is the platform product active on the account, NOT the Curviate seat entitlement, and the two can disagree: a lapsed subscription leaves the seat untouched. Curviate detects it from the platform when the account connects, re-detects it on every reconnect and, at most once a day, on an account read; setting it here is an operator override of that result and holds until the next connect. To undo the override, send `limit_profile_source: "default"`: the pin is released, and Curviate re-reads the value from LinkedIn on the account's next read or connect. Sending the value the account already holds changes nothing and pins nothing. The change is recorded in the ledger and it moves the defaults under every row at once, so any row you have configured explicitly keeps your value. The elevated Sales Navigator and Recruiter figures apply only to calls made through the matching interface, the Sales Navigator and Recruiter operations, and Curviate holds each call to the figure for the interface it goes through. The numbers here are therefore the ones a standard-interface call is held to, on every profile; a call through one of those operations resolves from the elevated set instead, and each row publishes that figure as `interface_ceiling`.
                      * @enum {string}
                      */
                     limit_profile?: "basic" | "premium" | "sales_navigator" | "recruiter";
                     /** @description The IANA zone this account's ACTIVITY window is read in, e.g. `Europe/Berlin`. Must be a real zone; anything else is a 400. Null clears it, which DISABLES the activity window for every row that has not set its own: a guessed zone inverts the window, which is worse than not having one. */
                     timezone?: string | null;
                     /**
-                     * @description The tenant-wide posture default, which every account inherits unless it overrides it. Set it once for a whole workspace of personas. Null clears it back to `warn`.
+                     * @description The tenant-wide posture default, which every account inherits unless it overrides it. Set it once for a whole tenant of personas. Null clears it back to `warn`.
                      * @enum {string|null}
                      */
                     tenant_default_posture?: "warn" | "enforce" | null;
@@ -30733,7 +30748,7 @@ export interface operations {
                         source_class?: "substrate" | "linkedin_official" | "practitioner" | "inferred" | "unseeded" | null;
                         /** @description READ-ONLY. `ceiling` with the account's warm-up ramp applied, which is what this row is actually held to. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                         effective_ceiling?: unknown;
-                        /** @description READ-ONLY. What a call through the matching elevated interface (`/v1/{account_id}/sales-navigator/...`, `/v1/{account_id}/recruiter/...`) is held to on this row, or null when this row and limit profile have no such figure. `ceiling`, `effective_ceiling`, `band` and `over_default` are all the STANDARD-interface figure, so on a `sales_navigator` or `recruiter` account a row can report `over` while a call through the elevated interface still succeeds. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
+                        /** @description READ-ONLY. What a call through the matching elevated interface (the Sales Navigator and Recruiter operations) is held to on this row, or null when this row and limit profile have no such figure. `ceiling`, `effective_ceiling`, `band` and `over_default` are all the STANDARD-interface figure, so on a `sales_navigator` or `recruiter` account a row can report `over` while a call through the elevated interface still succeeds. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                         interface_ceiling?: unknown;
                         /** @description READ-ONLY. `interface_ceiling` with the account's warm-up ramp applied. Read THIS to know where an elevated-interface call stops, for the same reason `effective_ceiling` and not `ceiling` answers that for a standard one. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                         effective_interface_ceiling?: unknown;
@@ -31248,7 +31263,7 @@ export interface operations {
                              * @enum {string|null}
                              */
                             source_class?: "substrate" | "linkedin_official" | "practitioner" | "inferred" | "unseeded" | null;
-                            /** @description READ-ONLY. What a call through the matching elevated interface (`/v1/{account_id}/sales-navigator/...`, `/v1/{account_id}/recruiter/...`) is held to on this row, or null when this row and limit profile have no such figure. `ceiling`, `effective_ceiling`, `band` and `over_default` are all the STANDARD-interface figure, so on a `sales_navigator` or `recruiter` account a row can report `over` while a call through the elevated interface still succeeds. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
+                            /** @description READ-ONLY. What a call through the matching elevated interface (the Sales Navigator and Recruiter operations) is held to on this row, or null when this row and limit profile have no such figure. `ceiling`, `effective_ceiling`, `band` and `over_default` are all the STANDARD-interface figure, so on a `sales_navigator` or `recruiter` account a row can report `over` while a call through the elevated interface still succeeds. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                             interface_ceiling?: unknown;
                             /** @description READ-ONLY. The fields on this row configured above the Curviate default. Sent back on a write it is accepted and ignored, so the whole document round-trips; it is never stored and never ledgered. */
                             over_default?: unknown;