@portalshq/capability-queue-broadcast 0.1.2

package/dist/generated/api.d.ts

@@ -0,0 +1,500 @@
+/**
+ * Generated by orval v8.22.0 🍺
+ * Do not edit manually.
+ * Queue Broadcast Server
+ * OpenAPI spec version: 0.3.0
+ */
+export type BodyUploadQueueItemMediaType = typeof BodyUploadQueueItemMediaType[keyof typeof BodyUploadQueueItemMediaType];
+export declare const BodyUploadQueueItemMediaType: {
+    readonly video: "video";
+    readonly image: "image";
+    readonly audio: "audio";
+};
+export interface BodyUploadQueueItem {
+    duration?: number | null;
+    file: Blob;
+    media_type?: BodyUploadQueueItemMediaType;
+    sha256?: string | null;
+    slot_key?: string | null;
+    staged?: boolean;
+}
+export interface BodyUploadQueuePair {
+    audio: Blob;
+    /**
+       * @minLength 64
+       * @maxLength 64
+       */
+    audio_sha256: string;
+    image: Blob;
+    /**
+       * @minimum 1
+       * @maximum 30
+       */
+    image_duration: number;
+    /**
+       * @minLength 64
+       * @maxLength 64
+       */
+    image_sha256: string;
+    staged?: boolean;
+}
+export interface ErrorResponse {
+    detail: string;
+}
+export type ValidationErrorCtx = {
+    [key: string]: unknown;
+};
+export interface ValidationError {
+    ctx?: ValidationErrorCtx;
+    input?: unknown;
+    loc: (string | number)[];
+    msg: string;
+    type: string;
+}
+export interface HTTPValidationError {
+    detail?: ValidationError[];
+}
+export type HealthResponseJobs = {
+    [key: string]: number;
+};
+export type HealthResponseMediaServer = typeof HealthResponseMediaServer[keyof typeof HealthResponseMediaServer];
+export declare const HealthResponseMediaServer: {
+    readonly up: "up";
+    readonly down: "down";
+};
+export interface HealthResponse {
+    jobs: HealthResponseJobs;
+    last_playout_error: string | null;
+    media_server: HealthResponseMediaServer;
+    ok: boolean;
+}
+export type JobResponseMediaType = typeof JobResponseMediaType[keyof typeof JobResponseMediaType];
+export declare const JobResponseMediaType: {
+    readonly video: "video";
+    readonly image: "image";
+    readonly audio: "audio";
+};
+export type JobResponseStatus = typeof JobResponseStatus[keyof typeof JobResponseStatus];
+export declare const JobResponseStatus: {
+    readonly ingesting: "ingesting";
+    readonly staged: "staged";
+    readonly queued: "queued";
+    readonly generating: "generating";
+    readonly ready: "ready";
+    readonly playing: "playing";
+    readonly done: "done";
+    readonly failed: "failed";
+};
+export interface JobResponse {
+    created_at: number;
+    duration: number | null;
+    error: string | null;
+    id: string;
+    media_type: JobResponseMediaType;
+    pair_id: string | null;
+    prompt: string;
+    slot_key: string | null;
+    source_url: string | null;
+    status: JobResponseStatus;
+    updated_at: number;
+}
+export interface PromptInput {
+    /**
+       * @minLength 1
+       * @maxLength 20000
+       */
+    prompt: string;
+}
+export type QueueItemJsonMediaType = typeof QueueItemJsonMediaType[keyof typeof QueueItemJsonMediaType];
+export declare const QueueItemJsonMediaType: {
+    readonly video: "video";
+    readonly image: "image";
+    readonly audio: "audio";
+};
+export interface QueueItemJson {
+    duration?: number | null;
+    media_type?: QueueItemJsonMediaType;
+    prompt?: string | null;
+    url?: string | null;
+}
+export interface QueuePairResponse {
+    audio: JobResponse;
+    image: JobResponse;
+    pair_id: string;
+}
+export interface QueueSlotResponse {
+    jobs: JobResponse[];
+    released: boolean;
+    slot_key: string;
+}
+export interface StreamFormatResponse {
+    audio: string;
+    fade_duration: number;
+    fps: number;
+    gop_seconds: number;
+    image_duration: number;
+    resolution: string;
+    video: string;
+}
+export interface StreamInfoResponse {
+    destination_count: number;
+    format: StreamFormatResponse;
+    hls: string;
+}
+export type getHealthResponse200 = {
+    data: HealthResponse;
+    status: 200;
+};
+export type getHealthResponse503 = {
+    data: HealthResponse;
+    status: 503;
+};
+export type getHealthResponseSuccess = (getHealthResponse200) & {
+    headers: Headers;
+};
+export type getHealthResponseError = (getHealthResponse503) & {
+    headers: Headers;
+};
+export type getHealthResponse = (getHealthResponseSuccess | getHealthResponseError);
+export declare const getGetHealthUrl: () => string;
+/**
+ * @summary Health
+ */
+export declare const getHealth: (options?: RequestInit) => Promise<getHealthResponse>;
+export type enqueueLegacyPromptResponse200 = {
+    data: JobResponse;
+    status: 200;
+};
+export type enqueueLegacyPromptResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type enqueueLegacyPromptResponse410 = {
+    data: ErrorResponse;
+    status: 410;
+};
+export type enqueueLegacyPromptResponse422 = {
+    data: ErrorResponse;
+    status: 422;
+};
+export type enqueueLegacyPromptResponseSuccess = (enqueueLegacyPromptResponse200) & {
+    headers: Headers;
+};
+export type enqueueLegacyPromptResponseError = (enqueueLegacyPromptResponse401 | enqueueLegacyPromptResponse410 | enqueueLegacyPromptResponse422) & {
+    headers: Headers;
+};
+export type enqueueLegacyPromptResponse = (enqueueLegacyPromptResponseSuccess | enqueueLegacyPromptResponseError);
+export declare const getEnqueueLegacyPromptUrl: () => string;
+/**
+ * @summary Submit Prompt Compat
+ */
+export declare const enqueueLegacyPrompt: (promptInput: PromptInput, options?: RequestInit) => Promise<enqueueLegacyPromptResponse>;
+export type getLegacyPromptResponse200 = {
+    data: JobResponse;
+    status: 200;
+};
+export type getLegacyPromptResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type getLegacyPromptResponse404 = {
+    data: ErrorResponse;
+    status: 404;
+};
+export type getLegacyPromptResponse422 = {
+    data: HTTPValidationError;
+    status: 422;
+};
+export type getLegacyPromptResponseSuccess = (getLegacyPromptResponse200) & {
+    headers: Headers;
+};
+export type getLegacyPromptResponseError = (getLegacyPromptResponse401 | getLegacyPromptResponse404 | getLegacyPromptResponse422) & {
+    headers: Headers;
+};
+export type getLegacyPromptResponse = (getLegacyPromptResponseSuccess | getLegacyPromptResponseError);
+export declare const getGetLegacyPromptUrl: (jobId: string) => string;
+/**
+ * @summary Prompt Status
+ */
+export declare const getLegacyPrompt: (jobId: string, options?: RequestInit) => Promise<getLegacyPromptResponse>;
+export type enqueueQueueItemResponse200 = {
+    data: JobResponse;
+    status: 200;
+};
+export type enqueueQueueItemResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type enqueueQueueItemResponse409 = {
+    data: ErrorResponse;
+    status: 409;
+};
+export type enqueueQueueItemResponse413 = {
+    data: ErrorResponse;
+    status: 413;
+};
+export type enqueueQueueItemResponse422 = {
+    data: ErrorResponse;
+    status: 422;
+};
+export type enqueueQueueItemResponse429 = {
+    data: ErrorResponse;
+    status: 429;
+};
+export type enqueueQueueItemResponseSuccess = (enqueueQueueItemResponse200) & {
+    headers: Headers;
+};
+export type enqueueQueueItemResponseError = (enqueueQueueItemResponse401 | enqueueQueueItemResponse409 | enqueueQueueItemResponse413 | enqueueQueueItemResponse422 | enqueueQueueItemResponse429) & {
+    headers: Headers;
+};
+export type enqueueQueueItemResponse = (enqueueQueueItemResponseSuccess | enqueueQueueItemResponseError);
+export declare const getEnqueueQueueItemUrl: () => string;
+/**
+ * @summary Queue Json
+ */
+export declare const enqueueQueueItem: (queueItemJson: QueueItemJson, options?: RequestInit) => Promise<enqueueQueueItemResponse>;
+export type uploadQueuePairResponse200 = {
+    data: QueuePairResponse;
+    status: 200;
+};
+export type uploadQueuePairResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type uploadQueuePairResponse409 = {
+    data: ErrorResponse;
+    status: 409;
+};
+export type uploadQueuePairResponse413 = {
+    data: ErrorResponse;
+    status: 413;
+};
+export type uploadQueuePairResponse422 = {
+    data: ErrorResponse;
+    status: 422;
+};
+export type uploadQueuePairResponse429 = {
+    data: ErrorResponse;
+    status: 429;
+};
+export type uploadQueuePairResponseSuccess = (uploadQueuePairResponse200) & {
+    headers: Headers;
+};
+export type uploadQueuePairResponseError = (uploadQueuePairResponse401 | uploadQueuePairResponse409 | uploadQueuePairResponse413 | uploadQueuePairResponse422 | uploadQueuePairResponse429) & {
+    headers: Headers;
+};
+export type uploadQueuePairResponse = (uploadQueuePairResponseSuccess | uploadQueuePairResponseError);
+export declare const getUploadQueuePairUrl: () => string;
+/**
+ * Atomically receive finished image and audio bytes from a remote producer.
+ *
+ * The two jobs stay `ingesting` until both files are checksum-verified and
+ * committed. `staged=true` persists the pair without making it eligible for
+ * playout; the authenticated release endpoint activates it later.
+ * @summary Queue Pair Upload
+ */
+export declare const uploadQueuePair: (bodyUploadQueuePair: BodyUploadQueuePair, options?: RequestInit) => Promise<uploadQueuePairResponse>;
+export type getQueuePairResponse200 = {
+    data: QueuePairResponse;
+    status: 200;
+};
+export type getQueuePairResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type getQueuePairResponse404 = {
+    data: ErrorResponse;
+    status: 404;
+};
+export type getQueuePairResponse422 = {
+    data: HTTPValidationError;
+    status: 422;
+};
+export type getQueuePairResponseSuccess = (getQueuePairResponse200) & {
+    headers: Headers;
+};
+export type getQueuePairResponseError = (getQueuePairResponse401 | getQueuePairResponse404 | getQueuePairResponse422) & {
+    headers: Headers;
+};
+export type getQueuePairResponse = (getQueuePairResponseSuccess | getQueuePairResponseError);
+export declare const getGetQueuePairUrl: (pairId: string) => string;
+/**
+ * @summary Queue Pair Status
+ */
+export declare const getQueuePair: (pairId: string, options?: RequestInit) => Promise<getQueuePairResponse>;
+export type releaseQueuePairResponse200 = {
+    data: QueuePairResponse;
+    status: 200;
+};
+export type releaseQueuePairResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type releaseQueuePairResponse404 = {
+    data: ErrorResponse;
+    status: 404;
+};
+export type releaseQueuePairResponse409 = {
+    data: ErrorResponse;
+    status: 409;
+};
+export type releaseQueuePairResponse422 = {
+    data: HTTPValidationError;
+    status: 422;
+};
+export type releaseQueuePairResponseSuccess = (releaseQueuePairResponse200) & {
+    headers: Headers;
+};
+export type releaseQueuePairResponseError = (releaseQueuePairResponse401 | releaseQueuePairResponse404 | releaseQueuePairResponse409 | releaseQueuePairResponse422) & {
+    headers: Headers;
+};
+export type releaseQueuePairResponse = (releaseQueuePairResponseSuccess | releaseQueuePairResponseError);
+export declare const getReleaseQueuePairUrl: (pairId: string) => string;
+/**
+ * @summary Release Queue Pair
+ */
+export declare const releaseQueuePair: (pairId: string, options?: RequestInit) => Promise<releaseQueuePairResponse>;
+export type getQueueSlotResponse200 = {
+    data: QueueSlotResponse;
+    status: 200;
+};
+export type getQueueSlotResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type getQueueSlotResponse404 = {
+    data: ErrorResponse;
+    status: 404;
+};
+export type getQueueSlotResponse422 = {
+    data: HTTPValidationError;
+    status: 422;
+};
+export type getQueueSlotResponseSuccess = (getQueueSlotResponse200) & {
+    headers: Headers;
+};
+export type getQueueSlotResponseError = (getQueueSlotResponse401 | getQueueSlotResponse404 | getQueueSlotResponse422) & {
+    headers: Headers;
+};
+export type getQueueSlotResponse = (getQueueSlotResponseSuccess | getQueueSlotResponseError);
+export declare const getGetQueueSlotUrl: (slotKey: string) => string;
+/**
+ * @summary Queue Slot Status
+ */
+export declare const getQueueSlot: (slotKey: string, options?: RequestInit) => Promise<getQueueSlotResponse>;
+export type releaseQueueSlotResponse200 = {
+    data: QueueSlotResponse;
+    status: 200;
+};
+export type releaseQueueSlotResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type releaseQueueSlotResponse404 = {
+    data: ErrorResponse;
+    status: 404;
+};
+export type releaseQueueSlotResponse409 = {
+    data: ErrorResponse;
+    status: 409;
+};
+export type releaseQueueSlotResponse422 = {
+    data: HTTPValidationError;
+    status: 422;
+};
+export type releaseQueueSlotResponseSuccess = (releaseQueueSlotResponse200) & {
+    headers: Headers;
+};
+export type releaseQueueSlotResponseError = (releaseQueueSlotResponse401 | releaseQueueSlotResponse404 | releaseQueueSlotResponse409 | releaseQueueSlotResponse422) & {
+    headers: Headers;
+};
+export type releaseQueueSlotResponse = (releaseQueueSlotResponseSuccess | releaseQueueSlotResponseError);
+export declare const getReleaseQueueSlotUrl: (slotKey: string) => string;
+/**
+ * @summary Release Queue Slot
+ */
+export declare const releaseQueueSlot: (slotKey: string, options?: RequestInit) => Promise<releaseQueueSlotResponse>;
+export type uploadQueueItemResponse200 = {
+    data: JobResponse;
+    status: 200;
+};
+export type uploadQueueItemResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type uploadQueueItemResponse413 = {
+    data: ErrorResponse;
+    status: 413;
+};
+export type uploadQueueItemResponse422 = {
+    data: ErrorResponse;
+    status: 422;
+};
+export type uploadQueueItemResponse429 = {
+    data: ErrorResponse;
+    status: 429;
+};
+export type uploadQueueItemResponseSuccess = (uploadQueueItemResponse200) & {
+    headers: Headers;
+};
+export type uploadQueueItemResponseError = (uploadQueueItemResponse401 | uploadQueueItemResponse413 | uploadQueueItemResponse422 | uploadQueueItemResponse429) & {
+    headers: Headers;
+};
+export type uploadQueueItemResponse = (uploadQueueItemResponseSuccess | uploadQueueItemResponseError);
+export declare const getUploadQueueItemUrl: () => string;
+/**
+ * @summary Queue Upload
+ */
+export declare const uploadQueueItem: (bodyUploadQueueItem: BodyUploadQueueItem, options?: RequestInit) => Promise<uploadQueueItemResponse>;
+export type getQueueItemResponse200 = {
+    data: JobResponse;
+    status: 200;
+};
+export type getQueueItemResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type getQueueItemResponse404 = {
+    data: ErrorResponse;
+    status: 404;
+};
+export type getQueueItemResponse422 = {
+    data: HTTPValidationError;
+    status: 422;
+};
+export type getQueueItemResponseSuccess = (getQueueItemResponse200) & {
+    headers: Headers;
+};
+export type getQueueItemResponseError = (getQueueItemResponse401 | getQueueItemResponse404 | getQueueItemResponse422) & {
+    headers: Headers;
+};
+export type getQueueItemResponse = (getQueueItemResponseSuccess | getQueueItemResponseError);
+export declare const getGetQueueItemUrl: (jobId: string) => string;
+/**
+ * @summary Queue Status
+ */
+export declare const getQueueItem: (jobId: string, options?: RequestInit) => Promise<getQueueItemResponse>;
+export type getStreamInfoResponse200 = {
+    data: StreamInfoResponse;
+    status: 200;
+};
+export type getStreamInfoResponse401 = {
+    data: ErrorResponse;
+    status: 401;
+};
+export type getStreamInfoResponse422 = {
+    data: HTTPValidationError;
+    status: 422;
+};
+export type getStreamInfoResponseSuccess = (getStreamInfoResponse200) & {
+    headers: Headers;
+};
+export type getStreamInfoResponseError = (getStreamInfoResponse401 | getStreamInfoResponse422) & {
+    headers: Headers;
+};
+export type getStreamInfoResponse = (getStreamInfoResponseSuccess | getStreamInfoResponseError);
+export declare const getGetStreamInfoUrl: () => string;
+/**
+ * @summary Stream Info
+ */
+export declare const getStreamInfo: (options?: RequestInit) => Promise<getStreamInfoResponse>;