@tai42/api-client 21.0.0 → 22.0.1

package/src/generated/openapi-schemas.ts

@@ -79,6 +79,15 @@ export type AgentsEntriesAdd = z.infer<typeof agentsEntriesAdd>;
 export const answerFormat = z.enum(["text","confirm","select","form","external","free"]);
 export type AnswerFormat = z.infer<typeof answerFormat>;
 
+export const formPageWording = z.object({ "choose_one": z.string().nullable().default(null), "date_unavailable": z.string().nullable().default(null), "failed": z.string().nullable().default(null), "network_error": z.string().nullable().default(null), "update_failed": z.string().nullable().default(null) }).strict();
+export type FormPageWording = z.infer<typeof formPageWording>;
+
+export const pageCopy = z.object({ "heading": z.string().nullable().default(null), "text": z.string().nullable().default(null) }).strict();
+export type PageCopy = z.infer<typeof pageCopy>;
+
+export const answerPageWording = z.object({ "awaiting": pageCopy.nullable().default(null), "confirm": pageCopy.nullable().default(null), "done": pageCopy.nullable().default(null), "form": formPageWording.nullable().default(null), "submitted": pageCopy.nullable().default(null) }).strict();
+export type AnswerPageWording = z.infer<typeof answerPageWording>;
+
 export const formOption = z.object({ "label": z.string().nullable().default(null), "value": z.string() }).strict();
 export type FormOption = z.infer<typeof formOption>;
 
@@ -88,7 +97,7 @@ export type FormData = z.infer<typeof formData>;
 export const displayBlock = z.object({ "alt": z.string().nullable().default(null), "kind": z.enum(["heading","body","image"]), "slot": z.string().nullable().default(null), "src": z.string().nullable().default(null), "text": z.string().nullable().default(null) }).strict();
 export type DisplayBlock = z.infer<typeof displayBlock>;
 
-export const formPage = z.object({ "display": z.array(displayBlock).default([]), "fields": z.array(z.string()), "kind": z.enum(["input","review"]).default("input"), "title": z.string() }).strict();
+export const formPage = z.object({ "button_label": z.string().nullable().default(null), "display": z.array(displayBlock).default([]), "fields": z.array(z.string()), "kind": z.enum(["input","review"]).default("input"), "title": z.string() }).strict();
 export type FormPage = z.infer<typeof formPage>;
 
 export const linkOption = z.object({ "kind": z.literal("link").default("link"), "label": z.string(), "url": z.string() }).strict();
@@ -109,7 +118,31 @@ export type ReplyOption = z.infer<typeof replyOption>;
 export const optionSection = z.object({ "rows": z.array(replyOption), "title": z.string() }).strict();
 export type OptionSection = z.infer<typeof optionSection>;
 
-export const answerPart = z.object({ "data": formData.nullable().default(null), "footer": z.string().nullable().default(null), "form_tag": z.string().nullable().default(null), "header": mediaItem.nullable().default(null), "location": locationElement.nullable().default(null), "media": z.array(mediaItem).nullable().default(null), "message": z.string().default(""), "options": z.array(z.discriminatedUnion("kind", [replyOption, linkOption])).nullable().default(null), "pages": z.array(formPage).nullable().default(null), "schema": z.record(z.string(), z.unknown()).nullable().default(null), "sections": z.array(optionSection).nullable().default(null), "template": channelTemplate.nullable().default(null) }).strict();
+export const answerWording = z.object({ "confirm": z.string().nullable().default(null), "decline": z.string().nullable().default(null), "open": z.string().nullable().default(null), "rejected": z.string().nullable().default(null), "rejected_final": z.string().nullable().default(null), "reply_hint": z.string().nullable().default(null), "submit": z.string().nullable().default(null) }).strict();
+export type AnswerWording = z.infer<typeof answerWording>;
+
+export const choiceWording = z.object({ "group_label": z.string().nullable().default(null), "label": z.string().nullable().default(null), "reply_hint": z.string().nullable().default(null) }).strict();
+export type ChoiceWording = z.infer<typeof choiceWording>;
+
+export const fieldWording = z.object({ "choice_label": z.string().nullable().default(null) }).strict();
+export type FieldWording = z.infer<typeof fieldWording>;
+
+export const formWording = z.object({ "back": z.string().nullable().default(null), "cancel": z.string().nullable().default(null), "fields": z.record(z.string(), fieldWording).default({}), "open": z.string().nullable().default(null), "review_empty": z.string().nullable().default(null), "submit": z.string().nullable().default(null), "title": z.string().nullable().default(null) }).strict();
+export type FormWording = z.infer<typeof formWording>;
+
+export const lineWording = z.object({ "answer_link": z.string().nullable().default(null), "deadline": z.string().nullable().default(null), "options": z.string().nullable().default(null), "reply": z.string().nullable().default(null) }).strict();
+export type LineWording = z.infer<typeof lineWording>;
+
+export const countdownWording = z.object({ "one_second_left": z.string().nullable().default(null), "seconds_left": z.string().nullable().default(null), "under_half_minute": z.string().nullable().default(null), "under_minute": z.string().nullable().default(null), "under_ten_seconds": z.string().nullable().default(null) }).strict();
+export type CountdownWording = z.infer<typeof countdownWording>;
+
+export const statusWording = z.object({ "answered": z.string().nullable().default(null), "closed": z.string().nullable().default(null), "countdown": countdownWording.nullable().default(null), "expired": z.string().nullable().default(null), "sending": z.string().nullable().default(null), "sent": z.string().nullable().default(null), "unavailable": z.string().nullable().default(null) }).strict();
+export type StatusWording = z.infer<typeof statusWording>;
+
+export const wording = z.object({ "answer": answerWording.nullable().default(null), "answer_page": answerPageWording.nullable().default(null), "choice": choiceWording.nullable().default(null), "form": formWording.nullable().default(null), "lines": lineWording.nullable().default(null), "status": statusWording.nullable().default(null) }).strict();
+export type Wording = z.infer<typeof wording>;
+
+export const answerPart = z.object({ "data": formData.nullable().default(null), "footer": z.string().nullable().default(null), "form_tag": z.string().nullable().default(null), "header": mediaItem.nullable().default(null), "location": locationElement.nullable().default(null), "media": z.array(mediaItem).nullable().default(null), "message": z.string().default(""), "options": z.array(z.discriminatedUnion("kind", [replyOption, linkOption])).nullable().default(null), "pages": z.array(formPage).nullable().default(null), "schema": z.record(z.string(), z.unknown()).nullable().default(null), "sections": z.array(optionSection).nullable().default(null), "template": channelTemplate.nullable().default(null), "wording": wording.nullable().default(null) }).strict();
 export type AnswerPart = z.infer<typeof answerPart>;
 
 export const overlapPolicy = z.object({ "deliver": z.enum(["one","all"]).default("one"), "running": z.enum(["continue","cancel"]).default("continue"), "settle_seconds": z.number().int().gte(0).lte(30).default(0) });
@@ -583,7 +616,7 @@ export type NotificationListing = z.infer<typeof notificationListing>;
 export const notifyResult = z.string();
 export type NotifyResult = z.infer<typeof notifyResult>;
 
-export const notifyUser = z.object({ "audience": z.string().nullable().default(null), "channel": z.string().nullable().default(null), "data": formData.nullable().default(null), "footer": z.string().nullable().default(null), "form_tag": z.string().nullable().default(null), "header": mediaItem.nullable().default(null), "location": locationElement.nullable().default(null), "media": z.array(mediaItem).nullable().default(null), "message": z.string(), "options": z.array(z.discriminatedUnion("kind", [replyOption, linkOption])).nullable().default(null), "pages": z.array(formPage).nullable().default(null), "recipient": z.string().nullable().default(null), "schema": z.record(z.string(), z.unknown()).nullable().default(null), "sections": z.array(optionSection).nullable().default(null), "sender_identity": z.string().nullable().default(null), "template": channelTemplate.nullable().default(null) }).strict();
+export const notifyUser = z.object({ "audience": z.string().nullable().default(null), "channel": z.string().nullable().default(null), "data": formData.nullable().default(null), "footer": z.string().nullable().default(null), "form_tag": z.string().nullable().default(null), "header": mediaItem.nullable().default(null), "location": locationElement.nullable().default(null), "media": z.array(mediaItem).nullable().default(null), "message": z.string(), "options": z.array(z.discriminatedUnion("kind", [replyOption, linkOption])).nullable().default(null), "pages": z.array(formPage).nullable().default(null), "recipient": z.string().nullable().default(null), "schema": z.record(z.string(), z.unknown()).nullable().default(null), "sections": z.array(optionSection).nullable().default(null), "sender_identity": z.string().nullable().default(null), "template": channelTemplate.nullable().default(null), "wording": wording.nullable().default(null) }).strict();
 export type NotifyUser = z.infer<typeof notifyUser>;
 
 export const oAuthCancelled = z.object({ "kind": z.literal("cancelled"), "message": z.string() });

package/src/index.ts

@@ -76,6 +76,8 @@ export type { ApiConfig, RequestOptions } from './http';
 export { apiDownload, apiRequest, apiText } from './http';
 export type {
   AnswerFormat,
+  AnswerPageWording,
+  AnswerWording,
   ApiConversationRouteCreate,
   ApplyResult,
   AttachmentMediaItem,
@@ -90,6 +92,7 @@ export type {
   ChannelConversationRouteCreate,
   Channels,
   ChannelTemplate,
+  ChoiceWording,
   ClaimLinkCreated,
   CompletedOrigin,
   ConnectionView,
@@ -123,11 +126,13 @@ export type {
   ConversationThreadModeState,
   ConversationThreadsPage,
   ConversationTranscriptPage,
+  CountdownWording,
   DashboardMetrics,
   DiscoveredServer,
   DisplayBlock,
   DisplayBlockKind,
   Extension,
+  FieldWording,
   FleetOutcome,
   FleetReloadResult,
   FleetReportFanout,
@@ -143,6 +148,7 @@ export type {
   FormPages,
   FormReactions,
   FormUpdate,
+  FormWording,
   FreshLife,
   GrantLevel,
   HeldPendingSave,
@@ -159,6 +165,7 @@ export type {
   InviteRow,
   InvokeMemberActionResult,
   KindStatus,
+  LineWording,
   LoginFormField,
   LoginMethod,
   LoginMethods,
@@ -207,6 +214,7 @@ export type {
   Notifications,
   OAuthCompleteResult,
   ObservabilityCapabilities,
+  PageCopy,
   ParkedCallerAsk,
   ParkedStatus,
   PatternEntry,
@@ -286,6 +294,7 @@ export type {
   StateTemplateParameter,
   StateTemplateTrace,
   StateUpdate,
+  StatusWording,
   StorageInfo,
   StorageResourceStat,
   StudioPluginListingEntry,
@@ -316,6 +325,7 @@ export type {
   TriggerLinkRecord,
   ValidateConditionResult,
   VisitOutcome,
+  Wording,
   WorkerKind,
   WorkerLastOp,
   WorkerState,

package/src/schemas/interactions.ts

@@ -88,16 +88,195 @@ export type FormPageKind = z.infer<typeof formPageKind>;
  * instead of, for a review page) its input fields; it defaults to empty, so a page that
  * carries none renders exactly as before. `kind` marks a `review` page — a terminal
  * summary step that shows the readback of entered values and the confirm/submit footer
- * and carries no new input fields; it defaults to `input`. Both are additive: an older
+ * and carries no new input fields; it defaults to `input`. `button_label` is the text of
+ * the page's primary button — the one that advances from an input page, or submits from
+ * the last — in the sender's words and the end-user's language; absent (`null`), the
+ * surface shows its own generic word ("Next"/"Submit"/"Confirm"). All additive: an older
  * payload ({title, fields}) parses unchanged.
  */
-export const formPage = openapi.formPage;
+export const formPage = openapi.formPage.extend({
+  button_label: z.string().nullable().default(null),
+});
 export type FormPage = z.infer<typeof formPage>;
 
 /** The `form` pages list (`format_payload.pages`), safeParsed as a whole by the preview. */
 export const formPages = z.array(formPage);
 export type FormPages = z.infer<typeof formPages>;
 
+// The one catalogue of a send's platform-drawn texts (`format_payload.wording`): a
+// question's or a notification's buttons, headings, input hints, message lines,
+// answer-page sentences, refusal sentences, settled-card badges and screen-reader labels,
+// grouped into six chapters. Every leaf is the sender's own words in the end-user's
+// language; absent (or `null`), the surface shows its own generic word. Mirrors the
+// skeleton's `Wording` model member-for-member. A renderer safeParses this off the loose
+// `format_payload`, so a malformed shape falls back to the default words rather than
+// crashing the card (the labels are chrome, never an answer). The Studio inbox draws only
+// the subset of members it has a control for; the rest parse and are ignored.
+
+/**
+ * One form field's platform-drawn words (`wording.form.fields[name]`): `choice_label` is
+ * the placeholder of the field's picker (its empty-state prompt).
+ */
+export const fieldWording = z.object({
+  choice_label: z.string().nullish(),
+});
+export type FieldWording = z.infer<typeof fieldWording>;
+
+/**
+ * A form's platform-drawn chrome (`wording.form`): `title` heads the form surface;
+ * `open`/`cancel` label the buttons that open and close it; `back` the button that returns
+ * to the previous step; `submit` the terminal button of a form with no pages;
+ * `review_empty` the review step's line before anything is filled; `fields` carries
+ * per-field words keyed by property name. The inbox draws the form inline, so it reads
+ * `back`, `submit` and `fields`; `title`/`open`/`cancel`/`review_empty` parse unused.
+ */
+export const formWording = z.object({
+  title: z.string().nullish(),
+  open: z.string().nullish(),
+  cancel: z.string().nullish(),
+  back: z.string().nullish(),
+  submit: z.string().nullish(),
+  review_empty: z.string().nullish(),
+  fields: z.record(z.string(), fieldWording).nullish(),
+});
+export type FormWording = z.infer<typeof formWording>;
+
+/**
+ * A choice list's platform-drawn words (`wording.choice`): `label` is the word on the
+ * control that presents the list, `reply_hint` the line under a numbered-text list, and
+ * `group_label` the accessible name of a flat group of option buttons. The inbox reads
+ * `label` (the select field's label and picker placeholder); the rest parse unused.
+ */
+export const choiceWording = z.object({
+  label: z.string().nullish(),
+  reply_hint: z.string().nullish(),
+  group_label: z.string().nullish(),
+});
+export type ChoiceWording = z.infer<typeof choiceWording>;
+
+/**
+ * A non-form question's answer controls and refusal sentences (`wording.answer`): `open`
+ * labels the control that opens a `confirm`/`external` question's answer page, `confirm`
+ * its affirmative control, `decline` its negative control, `submit` the button that sends a
+ * typed or picked answer, `reply_hint` the hint in an empty reply input. `rejected` /
+ * `rejected_final` are the sentences the end user reads when an answer is refused; the
+ * inbox draws neither (web-only). The inbox reads `open`, `confirm`, `decline`, `submit`
+ * and `reply_hint` where it draws the matching control.
+ */
+export const answerWording = z.object({
+  open: z.string().nullish(),
+  confirm: z.string().nullish(),
+  decline: z.string().nullish(),
+  submit: z.string().nullish(),
+  reply_hint: z.string().nullish(),
+  rejected: z.string().nullish(),
+  rejected_final: z.string().nullish(),
+});
+export type AnswerWording = z.infer<typeof answerWording>;
+
+/**
+ * The lines of a delivery message (`wording.lines`): `answer_link` carries the tappable
+ * answer link, `deadline` names the deadline, `reply` tells the end user how to reply, and
+ * `options` lists the choices. Drawn by the chat channels; the inbox draws none of them.
+ */
+export const lineWording = z.object({
+  answer_link: z.string().nullish(),
+  deadline: z.string().nullish(),
+  reply: z.string().nullish(),
+  options: z.string().nullish(),
+});
+export type LineWording = z.infer<typeof lineWording>;
+
+/** The heading and sentence of one platform-drawn answer page (`wording.answer_page.*`). */
+export const pageCopy = z.object({
+  heading: z.string().nullish(),
+  text: z.string().nullish(),
+});
+export type PageCopy = z.infer<typeof pageCopy>;
+
+/**
+ * The form page's own sentences (`wording.answer_page.form`): `failed` when a send did not
+ * land, `network_error` when the browser could not reach the server, `update_failed` when a
+ * reacting form could not refresh, `choose_one` for an empty required multi-choice, and
+ * `date_unavailable` for a blocked date. Drawn by the callback form page; the inbox draws
+ * none of them.
+ */
+export const formPageWording = z.object({
+  failed: z.string().nullish(),
+  network_error: z.string().nullish(),
+  update_failed: z.string().nullish(),
+  choose_one: z.string().nullish(),
+  date_unavailable: z.string().nullish(),
+});
+export type FormPageWording = z.infer<typeof formPageWording>;
+
+/**
+ * The pages a question's link opens (`wording.answer_page`): `confirm` the confirm page's
+ * copy, `done` the already-answered page's, `awaiting` the reply-on-the-channel page's,
+ * `submitted` the form page's post-submit copy, and `form` the form page's own
+ * validation/error sentences. Drawn by the callback pages; the inbox draws none of them.
+ */
+export const answerPageWording = z.object({
+  confirm: pageCopy.nullish(),
+  done: pageCopy.nullish(),
+  awaiting: pageCopy.nullish(),
+  submitted: pageCopy.nullish(),
+  form: formPageWording.nullish(),
+});
+export type AnswerPageWording = z.infer<typeof answerPageWording>;
+
+/**
+ * A live question card's countdown words (`wording.status.countdown`): `seconds_left` the
+ * visible plural line, `one_second_left` the visible singular, and `under_minute` /
+ * `under_half_minute` / `under_ten_seconds` the spoken lines at the three thresholds. Drawn
+ * by the web widget; the inbox draws no countdown.
+ */
+export const countdownWording = z.object({
+  seconds_left: z.string().nullish(),
+  one_second_left: z.string().nullish(),
+  under_minute: z.string().nullish(),
+  under_half_minute: z.string().nullish(),
+  under_ten_seconds: z.string().nullish(),
+});
+export type CountdownWording = z.infer<typeof countdownWording>;
+
+/**
+ * In-flight and settled status copy (`wording.status`): `sending` the screen-reader label
+ * while a send is in flight, `answered` / `expired` / `closed` the badges once a question
+ * settles, `sent` the badge after an ask-less form is submitted, `unavailable` the line
+ * when a form's door no longer resolves, and `countdown` the live-countdown words. Drawn by
+ * the web widget; the inbox draws none of them.
+ */
+export const statusWording = z.object({
+  sending: z.string().nullish(),
+  answered: z.string().nullish(),
+  expired: z.string().nullish(),
+  closed: z.string().nullish(),
+  sent: z.string().nullish(),
+  unavailable: z.string().nullish(),
+  countdown: countdownWording.nullish(),
+});
+export type StatusWording = z.infer<typeof statusWording>;
+
+/**
+ * The one catalogue of a send's platform-drawn texts (`format_payload.wording`), grouped
+ * by what each word decorates: the form (`form`), the choice list (`choice`), a question's
+ * answer controls and refusal sentences (`answer`), the lines of the delivery message
+ * (`lines`), the pages a question's link opens (`answer_page`), and in-flight and settled
+ * status (`status`). A page's primary button is the one text not here — it is on the page
+ * (`pages[].button_label`). Every leaf is the sender's own words in the end-user's
+ * language; absent (or `null`), the surface shows its own word.
+ */
+export const wording = z.object({
+  form: formWording.nullish(),
+  choice: choiceWording.nullish(),
+  answer: answerWording.nullish(),
+  lines: lineWording.nullish(),
+  answer_page: answerPageWording.nullish(),
+  status: statusWording.nullish(),
+});
+export type Wording = z.infer<typeof wording>;
+
 // The form reactions and the form update are hand-written: the spec carries them inside an
 // open `format_payload` and an open reaction `update`.