palbase 0.26.0 → 0.28.0

package/types/internal/src/modules/events.d.ts

@@ -2,6 +2,7 @@ import type { WebhookEvent } from '../event.js';
 import type { Events as AiEvents } from './ai.js';
 import type { Events as AnalyticsEvents } from './analytics.js';
 import type { Events as AuthEvents } from './auth.js';
+import type { Events as CallsEvents } from './calls.js';
 import type { Events as FlagsEvents } from './flags.js';
 import type { Events as JourneysEvents } from './journeys.js';
 import type { Events as MessagingEvents } from './messaging.js';
@@ -10,16 +11,16 @@ import type { Events as PurchasesEvents } from './purchases.js';
 import type { Events as StorageEvents } from './storage.js';
 import type { Events as StoresEvents } from './stores.js';
 /** Every event the modules' contracts say they send the project's webhooks (x-palbase-events), by type: its payload, the event's data. */
-export interface PlatformEvents extends AiEvents, AnalyticsEvents, AuthEvents, FlagsEvents, JourneysEvents, MessagingEvents, NotifyEvents, PurchasesEvents, StorageEvents, StoresEvents {
+export interface PlatformEvents extends AiEvents, AnalyticsEvents, AuthEvents, CallsEvents, FlagsEvents, JourneysEvents, MessagingEvents, NotifyEvents, PurchasesEvents, StorageEvents, StoresEvents {
 }
 /** A platform event's type: one a module's contract declares. */
 export type EventType = keyof PlatformEvents;
 /** Every platform event's type, as the contracts declare them. */
-export declare const EVENT_TYPES: readonly ["ai.goal.updated", "ai.response.completed", "ai.response.failed", "ai.response.started", "ai.voice.closed", "ai.voice.delegated", "ai.voice.started", "ai.workspace.published", "ai.workspace.pushed", "audience.entered", "audience.exited", "consent.changed", "device.revoked", "file.deleted", "file.moved", "file.uploaded", "flag.changed", "flag.override_changed", "journey.converted", "journey.ended", "journey.entered", "journey.event", "journey.step", "messaging.conversation.created", "messaging.conversation.deleted", "messaging.report.created", "notification.action", "notification.bounced", "notification.complained", "notification.delivered", "notification.dismissed", "notification.expired", "notification.failed", "notification.not_shown", "notification.opened", "notification.push_failing", "notification.read", "notification.received", "notification.rejected", "notification.sent", "notification.unconfirmed", "notification.undelivered", "notification.uninstalled", "purchases.catalog.applied", "purchases.catalog.changed", "purchases.coupon.redeemed", "purchases.credits.depleted", "purchases.credits.low", "purchases.customer.changed", "purchases.customer.erased", "purchases.customer.merged", "purchases.entitlement.changed", "purchases.offer.redeemed", "purchases.ownership.transferred", "purchases.paywall.published", "purchases.purchase.completed", "purchases.quota.exhausted", "purchases.quota.threshold", "purchases.refund.changed", "purchases.store.changed", "purchases.subscription.changed", "session.ended", "stores.action.changed", "stores.app.changed", "stores.apple.changed", "stores.apple.key.made", "stores.apple.key.revoked", "stores.apple.session.changed", "stores.apple.session.ended", "stores.apple.session.expired", "stores.beta_review.changed", "stores.build.changed", "stores.delivery.changed", "stores.delivery.requested", "stores.feedback.received", "stores.google.changed", "stores.group.changed", "stores.package.changed", "stores.play_release.changed", "stores.product.changed", "stores.review.message", "stores.version.changed", "stores.version.reviewed", "stores.vitals.changed", "stores.webhook.changed", "user.converted", "user.deleted", "user.locale_changed", "user.permissions_changed"];
+export declare const EVENT_TYPES: readonly ["ai.goal.updated", "ai.response.completed", "ai.response.failed", "ai.response.started", "ai.voice.closed", "ai.voice.delegated", "ai.voice.started", "ai.workspace.published", "ai.workspace.pushed", "audience.entered", "audience.exited", "calls.call.ended", "calls.call.started", "calls.participant.joined", "calls.participant.left", "consent.changed", "device.revoked", "file.deleted", "file.moved", "file.uploaded", "flag.changed", "flag.override_changed", "journey.converted", "journey.ended", "journey.entered", "journey.event", "journey.step", "messaging.conversation.created", "messaging.conversation.deleted", "messaging.conversation.read", "messaging.message.created", "messaging.report.created", "notification.action", "notification.bounced", "notification.complained", "notification.delivered", "notification.dismissed", "notification.expired", "notification.failed", "notification.not_shown", "notification.opened", "notification.push_failing", "notification.read", "notification.received", "notification.rejected", "notification.sent", "notification.unconfirmed", "notification.undelivered", "notification.uninstalled", "purchases.catalog.applied", "purchases.catalog.changed", "purchases.coupon.redeemed", "purchases.credits.depleted", "purchases.credits.low", "purchases.customer.changed", "purchases.customer.erased", "purchases.customer.merged", "purchases.entitlement.changed", "purchases.offer.redeemed", "purchases.ownership.transferred", "purchases.paywall.published", "purchases.purchase.completed", "purchases.quota.exhausted", "purchases.quota.threshold", "purchases.refund.changed", "purchases.store.changed", "purchases.subscription.changed", "session.ended", "stores.action.changed", "stores.app.changed", "stores.apple.changed", "stores.apple.key.made", "stores.apple.key.revoked", "stores.apple.session.changed", "stores.apple.session.ended", "stores.apple.session.expired", "stores.beta_review.changed", "stores.build.changed", "stores.delivery.changed", "stores.delivery.requested", "stores.feedback.received", "stores.google.changed", "stores.group.changed", "stores.package.changed", "stores.play_release.changed", "stores.product.changed", "stores.review.message", "stores.version.changed", "stores.version.reviewed", "stores.vitals.changed", "stores.webhook.changed", "user.converted", "user.deleted", "user.locale_changed", "user.permissions_changed"];
 /**
  * A platform event as delivered: one member per type the contracts declare,
  * its data that type's payload, so a switch on its type narrows it. An
  * event of a type none of them declares (one a newer platform sends) is no
  * member: at run time it reaches the switch's default, which takes it.
  */
-export type PalbaseEvent = WebhookEvent<PlatformEvents["ai.goal.updated"], "ai.goal.updated"> | WebhookEvent<PlatformEvents["ai.response.completed"], "ai.response.completed"> | WebhookEvent<PlatformEvents["ai.response.failed"], "ai.response.failed"> | WebhookEvent<PlatformEvents["ai.response.started"], "ai.response.started"> | WebhookEvent<PlatformEvents["ai.voice.closed"], "ai.voice.closed"> | WebhookEvent<PlatformEvents["ai.voice.delegated"], "ai.voice.delegated"> | WebhookEvent<PlatformEvents["ai.voice.started"], "ai.voice.started"> | WebhookEvent<PlatformEvents["ai.workspace.published"], "ai.workspace.published"> | WebhookEvent<PlatformEvents["ai.workspace.pushed"], "ai.workspace.pushed"> | WebhookEvent<PlatformEvents["audience.entered"], "audience.entered"> | WebhookEvent<PlatformEvents["audience.exited"], "audience.exited"> | WebhookEvent<PlatformEvents["consent.changed"], "consent.changed"> | WebhookEvent<PlatformEvents["device.revoked"], "device.revoked"> | WebhookEvent<PlatformEvents["file.deleted"], "file.deleted"> | WebhookEvent<PlatformEvents["file.moved"], "file.moved"> | WebhookEvent<PlatformEvents["file.uploaded"], "file.uploaded"> | WebhookEvent<PlatformEvents["flag.changed"], "flag.changed"> | WebhookEvent<PlatformEvents["flag.override_changed"], "flag.override_changed"> | WebhookEvent<PlatformEvents["journey.converted"], "journey.converted"> | WebhookEvent<PlatformEvents["journey.ended"], "journey.ended"> | WebhookEvent<PlatformEvents["journey.entered"], "journey.entered"> | WebhookEvent<PlatformEvents["journey.event"], "journey.event"> | WebhookEvent<PlatformEvents["journey.step"], "journey.step"> | WebhookEvent<PlatformEvents["messaging.conversation.created"], "messaging.conversation.created"> | WebhookEvent<PlatformEvents["messaging.conversation.deleted"], "messaging.conversation.deleted"> | WebhookEvent<PlatformEvents["messaging.report.created"], "messaging.report.created"> | WebhookEvent<PlatformEvents["notification.action"], "notification.action"> | WebhookEvent<PlatformEvents["notification.bounced"], "notification.bounced"> | WebhookEvent<PlatformEvents["notification.complained"], "notification.complained"> | WebhookEvent<PlatformEvents["notification.delivered"], "notification.delivered"> | WebhookEvent<PlatformEvents["notification.dismissed"], "notification.dismissed"> | WebhookEvent<PlatformEvents["notification.expired"], "notification.expired"> | WebhookEvent<PlatformEvents["notification.failed"], "notification.failed"> | WebhookEvent<PlatformEvents["notification.not_shown"], "notification.not_shown"> | WebhookEvent<PlatformEvents["notification.opened"], "notification.opened"> | WebhookEvent<PlatformEvents["notification.push_failing"], "notification.push_failing"> | WebhookEvent<PlatformEvents["notification.read"], "notification.read"> | WebhookEvent<PlatformEvents["notification.received"], "notification.received"> | WebhookEvent<PlatformEvents["notification.rejected"], "notification.rejected"> | WebhookEvent<PlatformEvents["notification.sent"], "notification.sent"> | WebhookEvent<PlatformEvents["notification.unconfirmed"], "notification.unconfirmed"> | WebhookEvent<PlatformEvents["notification.undelivered"], "notification.undelivered"> | WebhookEvent<PlatformEvents["notification.uninstalled"], "notification.uninstalled"> | WebhookEvent<PlatformEvents["purchases.catalog.applied"], "purchases.catalog.applied"> | WebhookEvent<PlatformEvents["purchases.catalog.changed"], "purchases.catalog.changed"> | WebhookEvent<PlatformEvents["purchases.coupon.redeemed"], "purchases.coupon.redeemed"> | WebhookEvent<PlatformEvents["purchases.credits.depleted"], "purchases.credits.depleted"> | WebhookEvent<PlatformEvents["purchases.credits.low"], "purchases.credits.low"> | WebhookEvent<PlatformEvents["purchases.customer.changed"], "purchases.customer.changed"> | WebhookEvent<PlatformEvents["purchases.customer.erased"], "purchases.customer.erased"> | WebhookEvent<PlatformEvents["purchases.customer.merged"], "purchases.customer.merged"> | WebhookEvent<PlatformEvents["purchases.entitlement.changed"], "purchases.entitlement.changed"> | WebhookEvent<PlatformEvents["purchases.offer.redeemed"], "purchases.offer.redeemed"> | WebhookEvent<PlatformEvents["purchases.ownership.transferred"], "purchases.ownership.transferred"> | WebhookEvent<PlatformEvents["purchases.paywall.published"], "purchases.paywall.published"> | WebhookEvent<PlatformEvents["purchases.purchase.completed"], "purchases.purchase.completed"> | WebhookEvent<PlatformEvents["purchases.quota.exhausted"], "purchases.quota.exhausted"> | WebhookEvent<PlatformEvents["purchases.quota.threshold"], "purchases.quota.threshold"> | WebhookEvent<PlatformEvents["purchases.refund.changed"], "purchases.refund.changed"> | WebhookEvent<PlatformEvents["purchases.store.changed"], "purchases.store.changed"> | WebhookEvent<PlatformEvents["purchases.subscription.changed"], "purchases.subscription.changed"> | WebhookEvent<PlatformEvents["session.ended"], "session.ended"> | WebhookEvent<PlatformEvents["stores.action.changed"], "stores.action.changed"> | WebhookEvent<PlatformEvents["stores.app.changed"], "stores.app.changed"> | WebhookEvent<PlatformEvents["stores.apple.changed"], "stores.apple.changed"> | WebhookEvent<PlatformEvents["stores.apple.key.made"], "stores.apple.key.made"> | WebhookEvent<PlatformEvents["stores.apple.key.revoked"], "stores.apple.key.revoked"> | WebhookEvent<PlatformEvents["stores.apple.session.changed"], "stores.apple.session.changed"> | WebhookEvent<PlatformEvents["stores.apple.session.ended"], "stores.apple.session.ended"> | WebhookEvent<PlatformEvents["stores.apple.session.expired"], "stores.apple.session.expired"> | WebhookEvent<PlatformEvents["stores.beta_review.changed"], "stores.beta_review.changed"> | WebhookEvent<PlatformEvents["stores.build.changed"], "stores.build.changed"> | WebhookEvent<PlatformEvents["stores.delivery.changed"], "stores.delivery.changed"> | WebhookEvent<PlatformEvents["stores.delivery.requested"], "stores.delivery.requested"> | WebhookEvent<PlatformEvents["stores.feedback.received"], "stores.feedback.received"> | WebhookEvent<PlatformEvents["stores.google.changed"], "stores.google.changed"> | WebhookEvent<PlatformEvents["stores.group.changed"], "stores.group.changed"> | WebhookEvent<PlatformEvents["stores.package.changed"], "stores.package.changed"> | WebhookEvent<PlatformEvents["stores.play_release.changed"], "stores.play_release.changed"> | WebhookEvent<PlatformEvents["stores.product.changed"], "stores.product.changed"> | WebhookEvent<PlatformEvents["stores.review.message"], "stores.review.message"> | WebhookEvent<PlatformEvents["stores.version.changed"], "stores.version.changed"> | WebhookEvent<PlatformEvents["stores.version.reviewed"], "stores.version.reviewed"> | WebhookEvent<PlatformEvents["stores.vitals.changed"], "stores.vitals.changed"> | WebhookEvent<PlatformEvents["stores.webhook.changed"], "stores.webhook.changed"> | WebhookEvent<PlatformEvents["user.converted"], "user.converted"> | WebhookEvent<PlatformEvents["user.deleted"], "user.deleted"> | WebhookEvent<PlatformEvents["user.locale_changed"], "user.locale_changed"> | WebhookEvent<PlatformEvents["user.permissions_changed"], "user.permissions_changed">;
+export type PalbaseEvent = WebhookEvent<PlatformEvents["ai.goal.updated"], "ai.goal.updated"> | WebhookEvent<PlatformEvents["ai.response.completed"], "ai.response.completed"> | WebhookEvent<PlatformEvents["ai.response.failed"], "ai.response.failed"> | WebhookEvent<PlatformEvents["ai.response.started"], "ai.response.started"> | WebhookEvent<PlatformEvents["ai.voice.closed"], "ai.voice.closed"> | WebhookEvent<PlatformEvents["ai.voice.delegated"], "ai.voice.delegated"> | WebhookEvent<PlatformEvents["ai.voice.started"], "ai.voice.started"> | WebhookEvent<PlatformEvents["ai.workspace.published"], "ai.workspace.published"> | WebhookEvent<PlatformEvents["ai.workspace.pushed"], "ai.workspace.pushed"> | WebhookEvent<PlatformEvents["audience.entered"], "audience.entered"> | WebhookEvent<PlatformEvents["audience.exited"], "audience.exited"> | WebhookEvent<PlatformEvents["calls.call.ended"], "calls.call.ended"> | WebhookEvent<PlatformEvents["calls.call.started"], "calls.call.started"> | WebhookEvent<PlatformEvents["calls.participant.joined"], "calls.participant.joined"> | WebhookEvent<PlatformEvents["calls.participant.left"], "calls.participant.left"> | WebhookEvent<PlatformEvents["consent.changed"], "consent.changed"> | WebhookEvent<PlatformEvents["device.revoked"], "device.revoked"> | WebhookEvent<PlatformEvents["file.deleted"], "file.deleted"> | WebhookEvent<PlatformEvents["file.moved"], "file.moved"> | WebhookEvent<PlatformEvents["file.uploaded"], "file.uploaded"> | WebhookEvent<PlatformEvents["flag.changed"], "flag.changed"> | WebhookEvent<PlatformEvents["flag.override_changed"], "flag.override_changed"> | WebhookEvent<PlatformEvents["journey.converted"], "journey.converted"> | WebhookEvent<PlatformEvents["journey.ended"], "journey.ended"> | WebhookEvent<PlatformEvents["journey.entered"], "journey.entered"> | WebhookEvent<PlatformEvents["journey.event"], "journey.event"> | WebhookEvent<PlatformEvents["journey.step"], "journey.step"> | WebhookEvent<PlatformEvents["messaging.conversation.created"], "messaging.conversation.created"> | WebhookEvent<PlatformEvents["messaging.conversation.deleted"], "messaging.conversation.deleted"> | WebhookEvent<PlatformEvents["messaging.conversation.read"], "messaging.conversation.read"> | WebhookEvent<PlatformEvents["messaging.message.created"], "messaging.message.created"> | WebhookEvent<PlatformEvents["messaging.report.created"], "messaging.report.created"> | WebhookEvent<PlatformEvents["notification.action"], "notification.action"> | WebhookEvent<PlatformEvents["notification.bounced"], "notification.bounced"> | WebhookEvent<PlatformEvents["notification.complained"], "notification.complained"> | WebhookEvent<PlatformEvents["notification.delivered"], "notification.delivered"> | WebhookEvent<PlatformEvents["notification.dismissed"], "notification.dismissed"> | WebhookEvent<PlatformEvents["notification.expired"], "notification.expired"> | WebhookEvent<PlatformEvents["notification.failed"], "notification.failed"> | WebhookEvent<PlatformEvents["notification.not_shown"], "notification.not_shown"> | WebhookEvent<PlatformEvents["notification.opened"], "notification.opened"> | WebhookEvent<PlatformEvents["notification.push_failing"], "notification.push_failing"> | WebhookEvent<PlatformEvents["notification.read"], "notification.read"> | WebhookEvent<PlatformEvents["notification.received"], "notification.received"> | WebhookEvent<PlatformEvents["notification.rejected"], "notification.rejected"> | WebhookEvent<PlatformEvents["notification.sent"], "notification.sent"> | WebhookEvent<PlatformEvents["notification.unconfirmed"], "notification.unconfirmed"> | WebhookEvent<PlatformEvents["notification.undelivered"], "notification.undelivered"> | WebhookEvent<PlatformEvents["notification.uninstalled"], "notification.uninstalled"> | WebhookEvent<PlatformEvents["purchases.catalog.applied"], "purchases.catalog.applied"> | WebhookEvent<PlatformEvents["purchases.catalog.changed"], "purchases.catalog.changed"> | WebhookEvent<PlatformEvents["purchases.coupon.redeemed"], "purchases.coupon.redeemed"> | WebhookEvent<PlatformEvents["purchases.credits.depleted"], "purchases.credits.depleted"> | WebhookEvent<PlatformEvents["purchases.credits.low"], "purchases.credits.low"> | WebhookEvent<PlatformEvents["purchases.customer.changed"], "purchases.customer.changed"> | WebhookEvent<PlatformEvents["purchases.customer.erased"], "purchases.customer.erased"> | WebhookEvent<PlatformEvents["purchases.customer.merged"], "purchases.customer.merged"> | WebhookEvent<PlatformEvents["purchases.entitlement.changed"], "purchases.entitlement.changed"> | WebhookEvent<PlatformEvents["purchases.offer.redeemed"], "purchases.offer.redeemed"> | WebhookEvent<PlatformEvents["purchases.ownership.transferred"], "purchases.ownership.transferred"> | WebhookEvent<PlatformEvents["purchases.paywall.published"], "purchases.paywall.published"> | WebhookEvent<PlatformEvents["purchases.purchase.completed"], "purchases.purchase.completed"> | WebhookEvent<PlatformEvents["purchases.quota.exhausted"], "purchases.quota.exhausted"> | WebhookEvent<PlatformEvents["purchases.quota.threshold"], "purchases.quota.threshold"> | WebhookEvent<PlatformEvents["purchases.refund.changed"], "purchases.refund.changed"> | WebhookEvent<PlatformEvents["purchases.store.changed"], "purchases.store.changed"> | WebhookEvent<PlatformEvents["purchases.subscription.changed"], "purchases.subscription.changed"> | WebhookEvent<PlatformEvents["session.ended"], "session.ended"> | WebhookEvent<PlatformEvents["stores.action.changed"], "stores.action.changed"> | WebhookEvent<PlatformEvents["stores.app.changed"], "stores.app.changed"> | WebhookEvent<PlatformEvents["stores.apple.changed"], "stores.apple.changed"> | WebhookEvent<PlatformEvents["stores.apple.key.made"], "stores.apple.key.made"> | WebhookEvent<PlatformEvents["stores.apple.key.revoked"], "stores.apple.key.revoked"> | WebhookEvent<PlatformEvents["stores.apple.session.changed"], "stores.apple.session.changed"> | WebhookEvent<PlatformEvents["stores.apple.session.ended"], "stores.apple.session.ended"> | WebhookEvent<PlatformEvents["stores.apple.session.expired"], "stores.apple.session.expired"> | WebhookEvent<PlatformEvents["stores.beta_review.changed"], "stores.beta_review.changed"> | WebhookEvent<PlatformEvents["stores.build.changed"], "stores.build.changed"> | WebhookEvent<PlatformEvents["stores.delivery.changed"], "stores.delivery.changed"> | WebhookEvent<PlatformEvents["stores.delivery.requested"], "stores.delivery.requested"> | WebhookEvent<PlatformEvents["stores.feedback.received"], "stores.feedback.received"> | WebhookEvent<PlatformEvents["stores.google.changed"], "stores.google.changed"> | WebhookEvent<PlatformEvents["stores.group.changed"], "stores.group.changed"> | WebhookEvent<PlatformEvents["stores.package.changed"], "stores.package.changed"> | WebhookEvent<PlatformEvents["stores.play_release.changed"], "stores.play_release.changed"> | WebhookEvent<PlatformEvents["stores.product.changed"], "stores.product.changed"> | WebhookEvent<PlatformEvents["stores.review.message"], "stores.review.message"> | WebhookEvent<PlatformEvents["stores.version.changed"], "stores.version.changed"> | WebhookEvent<PlatformEvents["stores.version.reviewed"], "stores.version.reviewed"> | WebhookEvent<PlatformEvents["stores.vitals.changed"], "stores.vitals.changed"> | WebhookEvent<PlatformEvents["stores.webhook.changed"], "stores.webhook.changed"> | WebhookEvent<PlatformEvents["user.converted"], "user.converted"> | WebhookEvent<PlatformEvents["user.deleted"], "user.deleted"> | WebhookEvent<PlatformEvents["user.locale_changed"], "user.locale_changed"> | WebhookEvent<PlatformEvents["user.permissions_changed"], "user.permissions_changed">;

package/types/internal/src/modules/index.d.ts

@@ -2,6 +2,7 @@ export * as ai from './ai.js';
 export * as analytics from './analytics.js';
 export * as auth from './auth.js';
 export * as cache from './cache.js';
+export * as calls from './calls.js';
 export * as flags from './flags.js';
 export * as journeys from './journeys.js';
 export * as machines from './machines.js';

package/types/internal/src/modules/messaging.d.ts

@@ -80,15 +80,27 @@ export type AdminConversationRequest = {
      */
     photo?: string;
     settings?: GroupSettings;
+    /**
+     * The place of the app's it belongs to, as the app names it (org:<id>, project:<id>): 1 to 128 letters, digits and : _ . / @ -. Fixed as it is made; absent: none.
+     */
+    space?: string;
     /**
      * A group's title.
      */
     title?: string;
+    /**
+     * open (a space named: required): found in its space's open groups and joined by whom the project's hook lets (POST …/join); closed (the default): joined when someone adds you. A direct conversation is never open.
+     */
+    visibility?: "open" | "closed";
 };
 /**
- * A message the project's server says, as the app.
+ * A message the project's server says: as the app, or as one of the conversation's people (as_user_id, with via).
  */
 export type AdminMessageRequest = {
+    /**
+     * The person it is written as: one of the conversation's people now. The message is theirs, as if they sent it — what they may send there, their read of it, the others' unread counts and pushes, from them — and says via what wrote it. Each is in the access log, the person named.
+     */
+    as_user_id?: string;
     /**
      * The server's own id of it: sent again with it, it is the same message.
      */
@@ -101,6 +113,14 @@ export type AdminMessageRequest = {
      * What it says.
      */
     text: string;
+    /**
+     * The message whose thread it answers.
+     */
+    thread_id?: string;
+    /**
+     * What wrote it (as pal), shown with the message (Message.via): 1 to 32 letters, digits and _ . -. Required with as_user_id — the others always know it was not the person's own hand.
+     */
+    via?: string;
 };
 /**
  * The project's server's word on a person's name and picture.
@@ -159,6 +179,10 @@ export type AdminUpdateConversation = {
      * A direct conversation's vanish mode.
      */
     vanish?: boolean;
+    /**
+     * A group's: open (found in its space's open groups and joined by whom the project's hook lets; the group has a space — 400 space_required otherwise) or closed. Its admins' (or the project's server's); a person opening one is asked of the hook first (open_group): refused, 403 not_allowed. Opened, whoever joins reads what its history shows newcomers (history_for_new_members).
+     */
+    visibility?: "open" | "closed";
 };
 /**
  * A file a message carries.
@@ -269,6 +293,51 @@ export type BlockPage = {
      */
     next_cursor?: string;
 };
+/**
+ * A call made from a conversation, as its call message keeps it (the calls module's word).
+ */
+export type CallRecord = {
+    /**
+     * When it was answered
+     */
+    answered_at: string | null;
+    /**
+     * The call (GET /calls/{call_id})
+     */
+    call_id: string;
+    /**
+     * Who called
+     */
+    caller_id: string;
+    /**
+     * Why it ended: hung_up, canceled, declined, missed, busy, failed or ended
+     */
+    end_reason: string | null;
+    /**
+     * When it ended
+     */
+    ended_at: string | null;
+    /**
+     * Two people, or a group
+     */
+    kind: "direct" | "group";
+    /**
+     * How long it lasted, from its answer to its end
+     */
+    seconds: number;
+    /**
+     * When it was made
+     */
+    started_at: string;
+    /**
+     * Ringing, going on, or over
+     */
+    state: "ringing" | "active" | "ended";
+    /**
+     * A video call (else voice)
+     */
+    video: boolean;
+};
 /**
  * A conversation as a member reads it.
  */
@@ -335,6 +404,10 @@ export type Conversation = {
      */
     photo: string | null;
     settings: ConversationSettings;
+    /**
+     * The place of the app's it belongs to (org:<id>, project:<id>), fixed as it was made; null: none. Always sent; absent (an answer kept from before it was): null.
+     */
+    space?: string | null;
     /**
      * A group's title.
      */
@@ -343,6 +416,10 @@ export type Conversation = {
      * How many times it changed.
      */
     version: number;
+    /**
+     * open: a group found in its space's open groups and joined by whom the project's hook lets; closed: joined when someone adds you (every direct conversation). Always sent; absent (an answer kept from before it was): closed.
+     */
+    visibility?: "open" | "closed";
 };
 /**
  * A conversation made, and whom it did not take.
@@ -374,6 +451,10 @@ export type ConversationCreatedEvent = {
      * Its people.
      */
     member_ids: string[];
+    /**
+     * Its space; null: none.
+     */
+    space?: string | null;
 };
 /**
  * messaging.conversation.deleted
@@ -398,6 +479,31 @@ export type ConversationPage = {
      */
     next_cursor?: string;
 };
+/**
+ * messaging.conversation.read
+ */
+export type ConversationReadEvent = {
+    /**
+     * The conversation.
+     */
+    conversation_id: string;
+    /**
+     * How far they read it (a message's seq).
+     */
+    read_seq: number;
+    /**
+     * The conversation's space; null: none.
+     */
+    space: string | null;
+    /**
+     * The thread they read; null: the conversation itself.
+     */
+    thread_id: string | null;
+    /**
+     * Who read it.
+     */
+    user_id: string;
+};
 /**
  * How a conversation runs.
  */
@@ -432,9 +538,13 @@ export type ConversationSettings = {
     vanish: boolean;
 };
 /**
- * Opens the direct conversation with a person.
+ * Opens the direct conversation with a person, in a space.
  */
 export type DirectRequest = {
+    /**
+     * The space it is in (org:<id>): the pair has one direct conversation in each space, and one with none. 1 to 128 letters, digits and : _ . / @ -; absent: none.
+     */
+    space?: string;
     /**
      * The other person.
      */
@@ -521,10 +631,18 @@ export type GroupRequest = {
      */
     photo?: string;
     settings?: GroupSettings;
+    /**
+     * The place of the app's it belongs to, as the app names it (org:<id>, project:<id>): 1 to 128 letters, digits and : _ . / @ -. Fixed as it is made; absent: none.
+     */
+    space?: string;
     /**
      * Its title.
      */
     title: string;
+    /**
+     * open (a space named: required): found in its space's open groups and joined by whom the project's hook lets (POST …/join); closed (the default): joined when someone adds you. A person's open group is asked of the project's hook first (open_group, the space named): refused, 403 not_allowed.
+     */
+    visibility?: "open" | "closed";
 };
 /**
  * How a group runs, as it is made.
@@ -569,7 +687,7 @@ export type HiddenMessage = {
  */
 export type HookSettings = {
     /**
-     * When it does not answer: allow everyone, or deny (the client retries).
+     * When it does not answer: allow everyone, or deny (the client retries). Allow is for a direct conversation and people added to a group alone: a space's open groups — having one, finding them, joining one — are refused (503 hook_unavailable) while it is silent, whatever this says.
      */
     on_error: "allow" | "deny";
     /**
@@ -586,7 +704,7 @@ export type HookSettings = {
  */
 export type HookSettingsRequest = {
     /**
-     * allow or deny (default).
+     * allow or deny (default). Allow never opens a space's open groups (open_group, list_open, join): those are refused while the hook is silent.
      */
     on_error?: "allow" | "deny";
     /**
@@ -749,6 +867,10 @@ export type Message = {
      * Its files.
      */
     attachments: Attachment[];
+    /**
+     * What a call message keeps of its call (kind call): written as the call starts, and again as it is answered and as it ends. It counts as no unread message.
+     */
+    call: CallRecord | null;
     /**
      * The writer's app's own id of it.
      */
@@ -782,9 +904,9 @@ export type Message = {
      */
     id: string;
     /**
-     * text, media (files) or system.
+     * text, media (files), system, or call (a call made from the conversation: `call` says how it went).
      */
-    kind: "text" | "media" | "system";
+    kind: "text" | "media" | "system" | "call";
     /**
      * When its thread was last answered.
      */
@@ -837,11 +959,76 @@ export type Message = {
      * How many times it changed (a reaction, an answer in its thread, an edit).
      */
     version: number;
+    /**
+     * What the project's server wrote it through, as one of the conversation's people or as the app (as pal): show it beside the message ("sent by Pal"). null: its writer wrote it. Always sent; absent (an answer kept from before it was): null.
+     */
+    via?: string | null;
     /**
      * When it is seen a limited number of times.
      */
     view_once: ViewOnce | null;
 };
+/**
+ * messaging.message.created
+ */
+export type MessageCreatedEvent = {
+    /**
+     * The conversation.
+     */
+    conversation_id: string;
+    /**
+     * direct or group.
+     */
+    conversation_kind: string;
+    /**
+     * When it was written.
+     */
+    created_at: string;
+    /**
+     * Whether it carries files.
+     */
+    has_attachments: boolean;
+    /**
+     * text or media (files).
+     */
+    kind: string;
+    /**
+     * Whom its words name.
+     */
+    mention_ids: string[];
+    /**
+     * The message: read it with the secret key (GET /messaging/admin/conversations/{conversation_id}/messages).
+     */
+    message_id: string;
+    /**
+     * Whom it is for: the conversation's people but its writer (and one blocking them, whom it never reaches).
+     */
+    recipient_ids: string[];
+    /**
+     * Its writer; null: the project's server, as the app.
+     */
+    sender_id: string | null;
+    /**
+     * Its place in the conversation.
+     */
+    seq: number;
+    /**
+     * The conversation's space; null: none.
+     */
+    space: string | null;
+    /**
+     * What it says, when the project lets the event say it (settings.event_text) — never a message meant to go (vanish mode, seen a limited number of times, living a while): the event stream keeps an event 7 days; absent otherwise.
+     */
+    text?: string;
+    /**
+     * The message whose thread it answers; null: none.
+     */
+    thread_id: string | null;
+    /**
+     * What the project's server wrote it through (as pal); null: its writer wrote it.
+     */
+    via: string | null;
+};
 export type MessagePage = {
     /**
      * The messages.
@@ -915,6 +1102,54 @@ export type NotificationsRequest = {
      */
     notify_level?: "all" | "mentions" | "none";
 };
+/**
+ * An open group of a space, as one who may find it reads it.
+ */
+export type OpenGroup = {
+    /**
+     * When it was made.
+     */
+    created_at: string;
+    /**
+     * Its description.
+     */
+    description: string | null;
+    /**
+     * The group.
+     */
+    id: string;
+    /**
+     * Whether the reader is in it.
+     */
+    joined: boolean;
+    /**
+     * When something was last said in it; null: nothing yet.
+     */
+    last_message_at: string | null;
+    /**
+     * How many people are in it.
+     */
+    member_count: number;
+    /**
+     * Where the app reads its picture.
+     */
+    photo: string | null;
+    /**
+     * Its space.
+     */
+    space: string;
+    /**
+     * Its title.
+     */
+    title: string | null;
+};
+export type OpenGroupPage = {
+    data: OpenGroup[];
+    /**
+     * The next page's cursor; absent on the last.
+     */
+    next_cursor?: string;
+};
 /**
  * A person as the conversations show them.
  */
@@ -1397,6 +1632,10 @@ export type Settings = {
      * A deleted user's messages: keep (their writer anonymous) or delete.
      */
     deleted_user_messages: "keep" | "delete";
+    /**
+     * Whether messaging.message.created says what the message says (text) — never a message meant to go (vanish mode, seen a limited number of times, living a while): the words leave the sealed store for the project's backend, kept on the event stream for 7 days. false: the backend reads the message with the secret key. Always sent; absent: false.
+     */
+    event_text?: boolean;
     /**
      * The hook asked whom one may reach; null: anyone may reach anyone.
      */
@@ -1426,6 +1665,10 @@ export type SettingsRequest = {
      * keep or delete.
      */
     deleted_user_messages?: "keep" | "delete";
+    /**
+     * Whether messaging.message.created says what the message says (text).
+     */
+    event_text?: boolean;
     /**
      * The hook; null removes it.
      */
@@ -1505,7 +1748,7 @@ export type SystemEvent = {
      */
     title?: string;
     /**
-     * What happened: created, members_added, member_left, member_removed, role_changed, title_changed, description_changed, photo_changed, timer_changed, vanish_on, vanish_off, settings_changed, read_only_on, read_only_off, screenshot. A person whose account was deleted is named deleted_… here, as everywhere.
+     * What happened: created, members_added, member_joined (one joined an open group by themselves), member_left, member_removed, role_changed, title_changed, description_changed, photo_changed, timer_changed, vanish_on, vanish_off, settings_changed, read_only_on, read_only_off, screenshot. A person whose account was deleted is named deleted_… here, as everywhere.
      */
     type: string;
     /**
@@ -1608,6 +1851,10 @@ export type UpdateConversation = {
      * A direct conversation's vanish mode.
      */
     vanish?: boolean;
+    /**
+     * A group's: open (found in its space's open groups and joined by whom the project's hook lets; the group has a space — 400 space_required otherwise) or closed. Its admins' (or the project's server's); a person opening one is asked of the hook first (open_group): refused, 403 not_allowed. Opened, whoever joins reads what its history shows newcomers (history_for_new_members).
+     */
+    visibility?: "open" | "closed";
 };
 /**
  * Changes a member's role.
@@ -1788,6 +2035,14 @@ export interface Events {
      * messaging.conversation.deleted: a conversation was deleted for everyone.
      */
     "messaging.conversation.deleted": ConversationDeletedEvent;
+    /**
+     * messaging.conversation.read: a person read a conversation, or a thread of it, further (a read receipt, or clearing it). Told only to the endpoints that name it, and written only while one does.
+     */
+    "messaging.conversation.read": ConversationReadEvent;
+    /**
+     * messaging.message.created: a message reached a conversation — a person's, or the project's server's (as the app, or as a person: via) — with whom it is for and whom it names. Told only to the endpoints that name it (an endpoint of every event is not sent it), and written only while one does.
+     */
+    "messaging.message.created": MessageCreatedEvent;
     /**
      * messaging.report.created: a person reported a conversation, someone in it or messages of it; read it with the secret key.
      */
@@ -1814,10 +2069,11 @@ export declare function client(t: Transport): {
      */
     adminListConversations(input?: {
         query?: {
-            user_id?: string; /** Another person, beside user_id: the direct conversation of the two (none when they have none). */
+            user_id?: string; /** Another person, beside user_id: the direct conversation of the two (none when they have none): their direct conversations in every space (space narrows them). */
             with?: string; /** How many (1 to 100; 30 when absent). */
             limit?: number; /** The cursor a page handed out (next_cursor). */
-            cursor?: string;
+            cursor?: string; /** Only the conversations of these spaces: one space a parameter, repeated for more, at most 20. */
+            space?: string[];
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, ConversationPage>>;
@@ -1906,7 +2162,7 @@ export declare function client(t: Transport): {
     /**
      * Say something in a conversation
      *
-     * The project's server says something in a conversation, as the app. Sent again with the same `client_message_id`, it is the same message.
+     * The project's server says something in a conversation — as the app (sender_id null), or as one of its people (as_user_id, with via): the message is theirs, as if they sent it (what they may send there, their read of it, the others' unread counts and pushes, from them), and says what wrote it (Message.via). In a thread too (thread_id). Sent again with the same client_message_id, it is the same message (200).
      */
     adminSendMessage(input: {
         path: {
@@ -2037,12 +2293,13 @@ export declare function client(t: Transport): {
     /**
      * The reader's conversations
      *
-     * The signed-in person's conversations, the latest first, with their own place in each, what they have not read and the last message each shows. A direct conversation someone else opened shows once something is said in it; one they cleared, once something new is.
+     * The signed-in person's conversations (of the spaces it names, when it names any), the latest first, with their own place in each, what they have not read and the last message each shows. A direct conversation someone else opened shows once something is said in it; one they cleared, once something new is.
      */
     listConversations(input?: {
         query?: {
             limit?: number; /** The cursor a page handed out (next_cursor). */
-            cursor?: string;
+            cursor?: string; /** Only the conversations of these spaces: one space a parameter, repeated for more (space=org:a&space=org:b), at most 20. */
+            space?: string[];
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, ConversationPage>>;
@@ -2123,6 +2380,17 @@ export declare function client(t: Transport): {
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<204, undefined>>;
+    /**
+     * Join an open group
+     *
+     * The reader joins an open group by themselves — when the project's hook lets them (action join, the group and its space named; with no hook, anyone) and it has room. They read it as one added to it does (its history when it shows it to newcomers), and its people are told (member_joined). Joining one they are in answers it as it is. One an admin removed does not join again by themselves.
+     */
+    joinGroup(input: {
+        path: {
+            conversation_id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Conversation>>;
     /**
      * A conversation's people
      *
@@ -2188,7 +2456,8 @@ export declare function client(t: Transport): {
             limit?: number; /** The cursor a page handed out (next_cursor). */
             cursor?: string; /** Open the timeline at this message: the page holds it, about half the page before it and half after (next_cursor pages back, newer_cursor forward). A thread's answer is read in its thread (`in_thread`). */
             around?: string; /** The cursor a page handed out to read on toward the newest (newer_cursor). */
-            after?: string;
+            after?: string; /** Only messages of this kind — text, media, system or call; several comma-separated (call: the calls made from the conversation). */
+            kind?: string;
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, MessagePage>>;
@@ -2371,6 +2640,19 @@ export declare function client(t: Transport): {
         body: UploadRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<201, Upload>>;
+    /**
+     * A space's open groups
+     *
+     * A space's open groups, the oldest first, each with whether the reader is in it — when the project's hook lets the reader find them (action list_open, the space named; with no hook, anyone). Join one with POST /messaging/conversations/{conversation_id}/join.
+     */
+    listOpenGroups(input: {
+        query: {
+            space: string; /** How many (1 to 100; 50 when absent). */
+            limit?: number; /** The cursor a page handed out (next_cursor). */
+            cursor?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, OpenGroupPage>>;
     /**
      * The reader's own profile
      *
@@ -2466,7 +2748,8 @@ export declare function client(t: Transport): {
             by?: "words" | "meaning"; /** Search one conversation of the reader's only. */
             conversation_id?: string; /** How many (1 to 50; 20 when absent). */
             limit?: number; /** The cursor a page handed out (next_cursor). */
-            cursor?: string;
+            cursor?: string; /** Search only the conversations of these spaces: one space a parameter, repeated for more, at most 20. */
+            space?: string[];
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, SearchPage>>;
@@ -2481,7 +2764,7 @@ export declare function client(t: Transport): {
     /**
      * Change how the project runs its conversations
      *
-     * What it names changes: how long messages are kept (null: for good), whether pushes say what a message says, what becomes of a deleted user's messages, and the hook asked whom one may reach (null: none). The hook is POSTed `{event: "messaging.can_message", action: "direct" | "group_add", from_user_id, to_user_ids, conversation_id}`, signed as Standard Webhooks sign (webhook-id, webhook-timestamp, webhook-signature), and answers 200 `{allowed_user_ids: [...]}`. A hook set for the first time is given its signing secret, here, once.
+     * What it names changes: how long messages are kept (null: for good), whether pushes say what a message says, what becomes of a deleted user's messages, the hook asked whom one may reach (null: none), and whether messaging.message.created says what a message says (event_text). The hook is POSTed `{event: "messaging.can_message", action: "direct" | "group_add" | "open_group" | "list_open" | "join", from_user_id, to_user_ids, conversation_id, space}` — whom of to_user_ids from_user_id may reach (a direct conversation, a group they are added to), or, to_user_ids being [from_user_id], whether they may have an open group in a space (open_group: making one, or opening theirs), find a space's open groups (list_open) or join one (join); space is the conversation's (absent: none), signed as Standard Webhooks sign (webhook-id, webhook-timestamp, webhook-signature), and answers 200 `{allowed_user_ids: [...]}`. A hook set for the first time is given its signing secret, here, once.
      */
     putSettings(input: {
         body: SettingsRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */

package/types/internal/src/modules/realtime.d.ts

@@ -307,7 +307,7 @@ export declare function client(t: Transport): {
     /**
      * Declare the channels
      *
-     * Replaces the project's channel declaration, in its order (100 at most). A pattern is ':'-separated segments; a {name} segment matches exactly one. `owner`: the pattern's one {name} must be the joining user, who may do everything on it. `public`: any signed-in user of the project subscribes, and may publish and read or write state as declared. A channel no pattern matches belongs to no one. roles:, flags:, messaging: and debug: are the platform's. Open sockets are decided again within a heartbeat.
+     * Replaces the project's channel declaration, in its order (100 at most). A pattern is ':'-separated segments; a {name} segment matches exactly one. `owner`: the pattern's one {name} must be the joining user, who may do everything on it. `public`: any signed-in user of the project subscribes, and may publish and read or write state as declared. A channel no pattern matches belongs to no one. roles:, flags:, messaging:, calls: and debug: are the platform's. Open sockets are decided again within a heartbeat.
      */
     putChannels(input: {
         body: ChannelDeclaration; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */

package/types/server/src/server.d.ts

@@ -26,6 +26,13 @@ export interface PalbaseServer {
     auth: ReturnType<typeof modules.auth.client>;
     /** The project's cache entries; palbase/backend's Cache is the way to use them. */
     cache: ReturnType<typeof modules.cache.client>;
+    /**
+     * The project's calls: their settings (getCallSettings, putCallSettings, rotateCallHookSecret), the calls read and
+     * ended (adminListCalls, adminGetCall, adminEndCall), and the project's own agent let into one —
+     * createCallTicket({ path: { call_id }, body: { identity } }) answers the media server's url and an access token its
+     * open-source agent libraries connect with as they are.
+     */
+    calls: ReturnType<typeof modules.calls.client>;
     /**
      * The project's encrypted database fields (fields.ts): `await
      * palbase.fields.load()` at startup, then encrypt, decrypt and lookup —
@@ -35,6 +42,14 @@ export interface PalbaseServer {
     fields: Fields;
     flags: ReturnType<typeof modules.flags.client>;
     machines: ReturnType<typeof modules.machines.client>;
+    /**
+     * The messaging module's calls as its contract states them. The project's server makes its admin ones with the
+     * secret key: a conversation for people (adminCreateConversation, in a space), a message as the app or as one of
+     * the conversation's people (adminSendMessage with as_user_id and via: "pal" — the others see it was not their own
+     * hand), its conversations by person, pair or space (adminListConversations). A person's own calls are their app's
+     * (palbase/web, the iOS and Android SDKs), with their session.
+     */
+    messaging: ReturnType<typeof modules.messaging.client>;
     notify: ReturnType<typeof modules.notify.client>;
     purchases: ReturnType<typeof modules.purchases.client>;
     realtime: ReturnType<typeof modules.realtime.client>;