@pitcher/js-api 1.27.3 → 1.29.0

package/lib/components/CRichTextEditor/components/CTextTypeSelect.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/composables/useCourseOnlyApps.d.ts

@@ -0,0 +1,11 @@
+import { AppFile } from '../types/app';
+/**
+ * Course-only apps (`module.canvas.course_only`, e.g. the L&D assessment-canvas wrap, PIT-6978) are
+ * offered in the Add-Component / Embeddable pickers ONLY where the host opts in via
+ * `provide('allowCourseOnlyApps', true)` — course-canvas-host does; normal sales / DSR canvases don't.
+ * Shared by AddComponentModal + Embeddable.settings so the two filters can't drift.
+ */
+export declare function useCourseOnlyApps(): {
+    allowCourseOnlyApps: boolean;
+    isAppAllowed: (app: AppFile) => boolean;
+};

package/lib/sdk/api/HighLevelApi.d.ts

@@ -1,6 +1,5 @@
 import { LowLevelApi } from './LowLevelApi';
 import { PitcherEvent, ApiOptions } from '../interfaces';
-import * as modules from './modules';
 /**
  * Creates a high-level API instance and caches it. Reterns a new instance only if new options are provided.
  */
@@ -126,14 +125,17 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     aiGetCapabilities(): Promise<import('../payload.types').AIRuntimeCapabilities>;
     aiComplete(payload: import('../payload.types').AICompletePayload): Promise<import('../payload.types').AICompleteResult>;
     piaSearchAnswer(payload: import('../payload.types').PiaSearchAnswerPayload): Promise<import('../payload.types').PiaSearchAnswerResult>;
+    appsDbGetEntries(payload: import('../payload.types').AppsDbGetEntriesPayload): Promise<import('../payload.types').AppsDbEntriesResult>;
+    appsDbUpsertEntry(payload: import('../payload.types').AppsDbUpsertEntryPayload): Promise<import('../payload.types').AppsDbEntry>;
+    appsDbDeleteEntry(payload: import('../payload.types').AppsDbDeleteEntryPayload): Promise<void>;
+    appsDbPsql(payload: import('../payload.types').AppsDbPsqlPayload): Promise<import('../payload.types').AppsDbEntriesResult>;
     open(payload?: import('../payload.types').OpenRequestPayload): Promise<string>;
     openExternalUrl(payload: import('../payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('../interfaces').PitcherEnv>;
     updateMyUser(payload: {
-        language?: import('../../main.lib').LanguageEnum | undefined;
+        language?: string | undefined;
     }): Promise<import('../../main.lib').User>;
     isOffline(): Promise<boolean>;
-    getLanguages(): Promise<modules.Language[]>;
     getCanvases(payload: import('../../main.lib').GetCanvasesParams & {
         filters?: Record<string, any>;
         fields?: string;
@@ -301,5 +303,13 @@ export declare function createHighLevelApi(options?: ApiOptions): {
         canvas_id: import('../../main.lib').CanvasRetrieve["id"];
         theme_id: import('../../main.lib').CanvasThemeRetrieve["id"];
     }>;
+    sttStart(payload: import('../payload.types').SttStartPayload): Promise<void>;
+    sttAvailability(): Promise<import('../payload.types').SttAvailabilityResult>;
+    sttWarmup(): Promise<void>;
+    sttStop(payload: import('../payload.types').SttStopPayload): Promise<import('../payload.types').SttStopResult>;
+    sttErrorCode(error: unknown): import('../payload.types').SttErrorCode | undefined;
+    ttsSpeak(payload: import('../payload.types').TtsSpeakPayload): Promise<import('../payload.types').TtsSpeakResult>;
+    ttsStop(): Promise<void>;
+    ttsErrorCode(error: unknown): import('../payload.types').TtsErrorCode | undefined;
     API: LowLevelApi;
 };

package/lib/sdk/api/modules/admin/types.admin.d.ts

@@ -254,6 +254,7 @@ export type AdminEnv = {
     mode?: PitcherEnv['mode'];
     pitcher: PitcherEnv['pitcher'];
     launch_darkly?: LaunchDarklyEnv;
+    ui_locale?: PitcherEnv['ui_locale'];
     client_type?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
     crm_shape?: Record<string, any>;
     state?: PitcherEnv['state'];

package/lib/sdk/api/modules/appsDb.d.ts

@@ -0,0 +1,57 @@
+import { AppsDbDeleteEntryPayload, AppsDbEntriesResult, AppsDbEntry, AppsDbGetEntriesPayload, AppsDbPsqlPayload, AppsDbUpsertEntryPayload } from '../../payload.types';
+/**
+ * Lists AppsDB entries of a type, adapting to the platform:
+ * - Web: GET to the next-core AppsDB REST API.
+ * - iOS: reads the local offline mirror via the `appsdb_get_entries` bridge
+ *   request. Types not allowlisted in the `offline_appsdb_types` setting fail
+ *   with `code = type_not_synced` and automatically fall back to the network.
+ *
+ * @example
+ * const { entries } = await api.appsDbGetEntries({ type: 'favorite' })
+ */
+export declare function appsDbGetEntries(payload: AppsDbGetEntriesPayload): Promise<AppsDbEntriesResult>;
+/**
+ * Creates or updates (deep-merges) an AppsDB entry, adapting to the platform:
+ * - Web: POST (create) or PUT (update, when `id` is set) to the next-core AppsDB REST API.
+ * - iOS: the `appsdb_upsert_entry` bridge request writes on the server and
+ *   mirrors the authoritative result locally. Offline it rejects with
+ *   `code = offline_write_not_supported` — AppsDB writes are online-only.
+ *
+ * The `data` blob is sent verbatim (no key-casing transformation), and all
+ * `appsDb*` responses are likewise returned verbatim — even for
+ * `casing: 'camel'` consumers — so bridge and REST results are identical.
+ *
+ * @example
+ * const entry = await api.appsDbUpsertEntry({ type: 'favorite', user_id: 1, data: { file_id: 'abc' } })
+ */
+export declare function appsDbUpsertEntry(payload: AppsDbUpsertEntryPayload): Promise<AppsDbEntry>;
+/**
+ * Deletes an AppsDB entry (soft delete server-side), adapting to the platform:
+ * - Web: DELETE to the next-core AppsDB REST API.
+ * - iOS: the `appsdb_delete_entry` bridge request deletes on the server and
+ *   removes the entry from the local offline mirror. Offline it rejects with
+ *   `code = offline_write_not_supported`.
+ *
+ * @example
+ * await api.appsDbDeleteEntry({ id: '01H5ZXE7YP2JR6Q1Z2G3K4H5J6' })
+ */
+export declare function appsDbDeleteEntry(payload: AppsDbDeleteEntryPayload): Promise<void>;
+/**
+ * Runs a PSQL (SQL-like) query against AppsDB: POST to the next-core
+ * `/appsdb/psql` endpoint whenever the network is available.
+ *
+ * On iOS the local offline mirror (`appsdb_get_entries` + client-side
+ * evaluation of simple `field = literal` AND-chains) serves the query ONLY
+ * while the device is offline, or when an online fetch fails at the
+ * connection level. Online queries are always answered by the server: Hub
+ * flows use psql results to decide between creating and updating an entry,
+ * and the mirror can lag the server by a sync cycle (multi-device) — a stale
+ * empty read would turn an update into a duplicate create. Offline that same
+ * stale read is harmless because AppsDB writes are rejected offline anyway.
+ *
+ * @example
+ * const { entries } = await api.appsDbPsql({
+ *   query: "SELECT * FROM personalfolders WHERE user_id = 1 AND data.custom_domain = 'acme.my.pitcher.com'",
+ * })
+ */
+export declare function appsDbPsql(payload: AppsDbPsqlPayload): Promise<AppsDbEntriesResult>;

package/lib/sdk/api/modules/appsDb.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/sdk/api/modules/index.d.ts

@@ -1,7 +1,7 @@
 export * from './ai';
+export * from './appsDb';
 export * from './open';
 export * from './env';
-export * from './languages';
 export * from './canvas';
 export * from './files';
 export * from './filesRevisions';
@@ -20,3 +20,5 @@ export * from './feedback';
 export * from './webView';
 export * from './share';
 export * from './theme';
+export * from './stt';
+export * from './tts';

package/lib/sdk/api/modules/stt.d.ts

@@ -0,0 +1,65 @@
+import { SttAvailabilityResult, SttErrorCode, SttStartPayload, SttStopPayload, SttStopResult } from '../../payload.types';
+export declare function sttStart(payload: SttStartPayload): Promise<void>;
+/**
+ * Check whether dictation can be offered — a side-effect-free capability probe
+ * to gate a mic button. Does NOT prompt for the microphone or download a model.
+ * Answered by the native bridge on iOS and the Impact host on web.
+ *
+ * @returns {Promise<SttAvailabilityResult>} `{ available, engine, reason? }` —
+ *   `available` is true only when the feature is enabled AND an engine can run;
+ *   `engine` is what would answer {@link sttStart} (`"webspeech"` sends audio
+ *   off-device); `reason` is `"disabled"` or `"unsupported"` when not available.
+ *
+ * @example
+ * const { available, engine } = await api.sttAvailability()
+ * if (available) showMicButton({ warnCloud: engine === 'webspeech' })
+ */
+export declare function sttAvailability(): Promise<SttAvailabilityResult>;
+/**
+ * Pre-load the on-device dictation model so a later {@link sttStart} resolves
+ * instantly (and the mic-permission prompt appears immediately instead of after
+ * a download). **Web only** — on iOS the native side manages its own model
+ * lifecycle, so the bridge has no `stt.warmup` type and calling it there rejects
+ * `requestTypeDoesNotExists`.
+ *
+ * Fire-and-forget: don't block your UI on it and ignore rejections. It is
+ * idempotent (repeated / concurrent calls collapse to a single download) and a
+ * no-op when the feature is disabled or the engine has nothing to warm (Web
+ * Speech fallback). Call it right after {@link sttAvailability} reports
+ * `available` with `engine === 'whisper'`.
+ *
+ * @returns {Promise<void>} Resolves once the model is ready (or immediately when
+ *   there's nothing to warm).
+ *
+ * @example
+ * const { available, engine } = await api.sttAvailability()
+ * if (available) {
+ *   showMicButton()
+ *   if (engine === 'whisper') api.sttWarmup().catch(() => {}) // background, non-blocking
+ * }
+ */
+export declare function sttWarmup(): Promise<void>;
+/**
+ * Finalize a dictation session. Resolves with the final full transcript;
+ * rejects with `STT_NOT_RECORDING` if the session isn't active.
+ *
+ * @param {SttStopPayload} payload
+ * @param {string} payload.session_id - The id passed to the matching {@link sttStart}.
+ * @returns {Promise<SttStopResult>} The final `{ transcript }`.
+ *
+ * @example
+ * const { transcript } = await api.sttStop({ session_id: 'notes-1' })
+ */
+export declare function sttStop(payload: SttStopPayload): Promise<SttStopResult>;
+/**
+ * Extract the {@link SttErrorCode} from a rejected `sttStart` / `sttStop`,
+ * normalizing across hosts: the iOS bridge rejection (`error_code` /
+ * `errorCode`) and Impact web's `{ reason }` / error `message` string. Returns
+ * `undefined` if no known code is present.
+ *
+ * @example
+ * try { await api.sttStart({ session_id }) } catch (err) {
+ *   if (api.sttErrorCode(err) === 'STT_BUSY') showMicInUseHint()
+ * }
+ */
+export declare function sttErrorCode(error: unknown): SttErrorCode | undefined;

package/lib/sdk/api/modules/stt.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/sdk/api/modules/tts.d.ts

@@ -0,0 +1,41 @@
+import { TtsErrorCode, TtsSpeakPayload, TtsSpeakResult } from '../../payload.types';
+/**
+ * Speak text on the device speaker. Resolves when the utterance FINISHES;
+ * rejects with a {@link TtsErrorCode}.
+ *
+ * @param {TtsSpeakPayload} payload
+ * @param {string} payload.text - Text to speak. Empty/whitespace rejects with `TTS_EMPTY_TEXT`.
+ * @param {string} [payload.language] - BCP-47/ISO tag (e.g. `"en-US"`); requires
+ *   an installed offline voice, else rejects with `TTS_VOICE_UNAVAILABLE`. Omit
+ *   for the system voice.
+ * @param {number} [payload.rate] - Speech rate; clamped to the platform min…max.
+ * @param {number} [payload.pitch] - Speech pitch; clamped `0.5`…`2.0` (`1.0` = normal).
+ * @returns {Promise<TtsSpeakResult>} `{ completed }` — `true` if it finished
+ *   naturally, `false` if stopped or replaced by a newer `ttsSpeak`.
+ *
+ * @example
+ * const { completed } = await api.ttsSpeak({ text: 'Meeting summary saved.', language: 'en-US' })
+ */
+export declare function ttsSpeak(payload: TtsSpeakPayload): Promise<TtsSpeakResult>;
+/**
+ * Stop any in-flight speech. The in-flight {@link ttsSpeak} resolves with
+ * `{ completed: false }`.
+ *
+ * @returns {Promise<void>}
+ *
+ * @example
+ * await api.ttsStop()
+ */
+export declare function ttsStop(): Promise<void>;
+/**
+ * Extract the {@link TtsErrorCode} from a rejected {@link ttsSpeak}, normalizing
+ * across hosts: the iOS bridge APIError (`code` / `error_code` / `errorCode`)
+ * and a host `{ reason }` / error `message` string. Returns `undefined` if no
+ * known code is present.
+ *
+ * @example
+ * try { await api.ttsSpeak({ text, language }) } catch (err) {
+ *   if (api.ttsErrorCode(err) === 'TTS_VOICE_UNAVAILABLE') promptVoiceDownload()
+ * }
+ */
+export declare function ttsErrorCode(error: unknown): TtsErrorCode | undefined;

package/lib/sdk/api/modules/tts.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/sdk/interfaces.d.ts

@@ -5,6 +5,7 @@ import { PitcherInstance } from '../types/instance.types';
 import { LaunchDarklyEnv } from '../types/launchDarkly.types';
 import { CDP_EVENT_TYPE, CLIENT_TYPE } from '../constants/cdp.const';
 import { PeerConnectivityEvent } from './peer-connectivity';
+import { SttPartialEvent, SttInterruptedEvent } from './payload.types';
 export declare const PITCHER_EVENT: "PITCHER_EVENT";
 export declare enum PitcherMessageType {
     REQUEST = "PITCHER_REQUEST",
@@ -71,6 +72,10 @@ export interface PitcherEnv {
         active_canvas_id?: CanvasRetrieve['id'];
         canvas_correlation_id?: string;
     };
+    /** Locale the user picked in the Pitcher shell. Web only — iOS has no picker
+     * and reports `device_locale` instead. Apps should prefer this and fall back:
+     * `ui_locale || device_locale`. */
+    ui_locale?: string;
     device_locale?: string;
     sync_badge_value?: number;
 }
@@ -113,6 +118,12 @@ export interface StartCallPitcherEvent {
      * instead of "Unscheduled".
      */
     meeting_id?: string;
+    /**
+     * PIT-7462: start and immediately stop the call, opening the postcall form.
+     * The host seeds the call's eventDate from the scheduled meeting record
+     * (StartDateTime/EndDateTime) so the form never shows a 0-second duration.
+     */
+    jump_to_postcall?: boolean;
     canvas_id?: string;
     edit_mode?: 'true' | 'false';
     post_action?: string;
@@ -166,7 +177,9 @@ export declare enum PitcherEventName {
     ITEM_SHAREBOX_ADD_COMPLETED = "item_sharebox_add_completed",
     SYNC_BADGE_VALUE_REPORTED = "sync_badge_value_reported",
     SYNC_BOX_RESOLVE_ERROR_TAPPED = "sync_box_resolve_error_tapped",
-    PEER_CONNECTIVITY_EVENT = "peer_connectivity_event"
+    PEER_CONNECTIVITY_EVENT = "peer_connectivity_event",
+    STT_PARTIAL = "stt.partial",
+    STT_INTERRUPTED = "stt.interrupted"
 }
 export declare enum PitcherBroadcastedEventName {
     UI_SHOW_MODAL = "ui:show-modal",
@@ -487,6 +500,18 @@ export interface PitcherEventMap {
         last_error: string;
     };
     [PitcherEventName.PEER_CONNECTIVITY_EVENT]: PeerConnectivityEvent;
+    /**
+     * Speech-to-text dictation partial (PITCHER_REQUEST `stt.start` session).
+     * Cross-platform (iOS bridge and the web host engine). `text` is the FULL
+     * transcript so far — replace, don't append.
+     */
+    [PitcherEventName.STT_PARTIAL]: SttPartialEvent;
+    /**
+     * Speech-to-text dictation session ended WITHOUT a `stt.stop` (e.g. a call
+     * recording preempted the mic on iOS, or a fatal capture error on web). Stop
+     * waiting for partials and reset the field. Cross-platform.
+     */
+    [PitcherEventName.STT_INTERRUPTED]: SttInterruptedEvent;
     [PitcherBroadcastedEventName.UI_SHOW_MODAL]: void;
     [PitcherBroadcastedEventName.UI_HIDE_MODAL]: void;
     [PitcherBroadcastedEventName.FILE_DOWNLOAD]: {

package/lib/sdk/main.d.ts

@@ -198,14 +198,17 @@ export declare function useApi(options?: ApiOptions): {
     aiGetCapabilities(): Promise<import('./payload.types').AIRuntimeCapabilities>;
     aiComplete(payload: import('./payload.types').AICompletePayload): Promise<import('./payload.types').AICompleteResult>;
     piaSearchAnswer(payload: import('./payload.types').PiaSearchAnswerPayload): Promise<import('./payload.types').PiaSearchAnswerResult>;
+    appsDbGetEntries(payload: import('./payload.types').AppsDbGetEntriesPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
+    appsDbUpsertEntry(payload: import('./payload.types').AppsDbUpsertEntryPayload): Promise<import('./payload.types').AppsDbEntry>;
+    appsDbDeleteEntry(payload: import('./payload.types').AppsDbDeleteEntryPayload): Promise<void>;
+    appsDbPsql(payload: import('./payload.types').AppsDbPsqlPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
     open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
     updateMyUser(payload: {
-        language?: import('../main.lib').LanguageEnum | undefined;
+        language?: string | undefined;
     }): Promise<import('../main.lib').User>;
     isOffline(): Promise<boolean>;
-    getLanguages(): Promise<import('./api/modules').Language[]>;
     getCanvases(payload: import('../main.lib').GetCanvasesParams & {
         filters?: Record<string, any>;
         fields?: string;
@@ -369,6 +372,14 @@ export declare function useApi(options?: ApiOptions): {
         canvas_id: import('../main.lib').CanvasRetrieve["id"];
         theme_id: import('../main.lib').CanvasThemeRetrieve["id"];
     }>;
+    sttStart(payload: import('./payload.types').SttStartPayload): Promise<void>;
+    sttAvailability(): Promise<import('./payload.types').SttAvailabilityResult>;
+    sttWarmup(): Promise<void>;
+    sttStop(payload: import('./payload.types').SttStopPayload): Promise<import('./payload.types').SttStopResult>;
+    sttErrorCode(error: unknown): import('./payload.types').SttErrorCode | undefined;
+    ttsSpeak(payload: import('./payload.types').TtsSpeakPayload): Promise<import('./payload.types').TtsSpeakResult>;
+    ttsStop(): Promise<void>;
+    ttsErrorCode(error: unknown): import('./payload.types').TtsErrorCode | undefined;
     API: import('./api/LowLevelApi').LowLevelApi;
 } | {
     getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
@@ -491,14 +502,17 @@ export declare function useApi(options?: ApiOptions): {
         aiGetCapabilities(): Promise<import('./payload.types').AIRuntimeCapabilities>;
         aiComplete(payload: import('./payload.types').AICompletePayload): Promise<import('./payload.types').AICompleteResult>;
         piaSearchAnswer(payload: import('./payload.types').PiaSearchAnswerPayload): Promise<import('./payload.types').PiaSearchAnswerResult>;
+        appsDbGetEntries(payload: import('./payload.types').AppsDbGetEntriesPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
+        appsDbUpsertEntry(payload: import('./payload.types').AppsDbUpsertEntryPayload): Promise<import('./payload.types').AppsDbEntry>;
+        appsDbDeleteEntry(payload: import('./payload.types').AppsDbDeleteEntryPayload): Promise<void>;
+        appsDbPsql(payload: import('./payload.types').AppsDbPsqlPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
         open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
         openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
         getEnv(): Promise<import('./interfaces').PitcherEnv>;
         updateMyUser(payload: {
-            language?: import('../main.lib').LanguageEnum | undefined;
+            language?: string | undefined;
         }): Promise<import('../main.lib').User>;
         isOffline(): Promise<boolean>;
-        getLanguages(): Promise<import('./api/modules').Language[]>;
         getCanvases(payload: import('../main.lib').GetCanvasesParams & {
             filters?: Record<string, any>;
             fields?: string;
@@ -662,6 +676,14 @@ export declare function useApi(options?: ApiOptions): {
             canvas_id: import('../main.lib').CanvasRetrieve["id"];
             theme_id: import('../main.lib').CanvasThemeRetrieve["id"];
         }>;
+        sttStart(payload: import('./payload.types').SttStartPayload): Promise<void>;
+        sttAvailability(): Promise<import('./payload.types').SttAvailabilityResult>;
+        sttWarmup(): Promise<void>;
+        sttStop(payload: import('./payload.types').SttStopPayload): Promise<import('./payload.types').SttStopResult>;
+        sttErrorCode(error: unknown): import('./payload.types').SttErrorCode | undefined;
+        ttsSpeak(payload: import('./payload.types').TtsSpeakPayload): Promise<import('./payload.types').TtsSpeakResult>;
+        ttsStop(): Promise<void>;
+        ttsErrorCode(error: unknown): import('./payload.types').TtsErrorCode | undefined;
         API: import('./api/LowLevelApi').LowLevelApi;
     };
     openSharingSettings(payload: import('./api/modules/ui/types.ui').UiOpenSharingSettingsRequest): Promise<import('./api/modules/ui/types.ui').UiOpenSharingSettingsResponse>;
@@ -730,13 +752,16 @@ export declare function useApi(options?: ApiOptions): {
     aiGetCapabilities(): Promise<import('./payload.types').AIRuntimeCapabilities>;
     aiComplete(payload: import('./payload.types').AICompletePayload): Promise<import('./payload.types').AICompleteResult>;
     piaSearchAnswer(payload: import('./payload.types').PiaSearchAnswerPayload): Promise<import('./payload.types').PiaSearchAnswerResult>;
+    appsDbGetEntries(payload: import('./payload.types').AppsDbGetEntriesPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
+    appsDbUpsertEntry(payload: import('./payload.types').AppsDbUpsertEntryPayload): Promise<import('./payload.types').AppsDbEntry>;
+    appsDbDeleteEntry(payload: import('./payload.types').AppsDbDeleteEntryPayload): Promise<void>;
+    appsDbPsql(payload: import('./payload.types').AppsDbPsqlPayload): Promise<import('./payload.types').AppsDbEntriesResult>;
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
     updateMyUser(payload: {
-        language?: import('../main.lib').LanguageEnum | undefined;
+        language?: string | undefined;
     }): Promise<import('../main.lib').User>;
     isOffline(): Promise<boolean>;
-    getLanguages(): Promise<import('./api/modules').Language[]>;
     getCanvases(payload: import('../main.lib').GetCanvasesParams & {
         filters?: Record<string, any>;
         fields?: string;
@@ -891,6 +916,14 @@ export declare function useApi(options?: ApiOptions): {
         canvas_id: import('../main.lib').CanvasRetrieve["id"];
         theme_id: import('../main.lib').CanvasThemeRetrieve["id"];
     }>;
+    sttStart(payload: import('./payload.types').SttStartPayload): Promise<void>;
+    sttAvailability(): Promise<import('./payload.types').SttAvailabilityResult>;
+    sttWarmup(): Promise<void>;
+    sttStop(payload: import('./payload.types').SttStopPayload): Promise<import('./payload.types').SttStopResult>;
+    sttErrorCode(error: unknown): import('./payload.types').SttErrorCode | undefined;
+    ttsSpeak(payload: import('./payload.types').TtsSpeakPayload): Promise<import('./payload.types').TtsSpeakResult>;
+    ttsStop(): Promise<void>;
+    ttsErrorCode(error: unknown): import('./payload.types').TtsErrorCode | undefined;
     API: import('./api/LowLevelApi').LowLevelApi;
 } | {
     broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;