@liqhtworks/sophon-sdk 0.1.0

package/src/models/CreateWebhookRequest.ts

@@ -0,0 +1,76 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateWebhookRequest
+ */
+export interface CreateWebhookRequest {
+    /**
+     * HTTPS URL to receive webhook deliveries. Must not point to
+     * private, loopback, link-local, or multicast addresses (SSRF prevention).
+     * 
+     * @type {string}
+     * @memberof CreateWebhookRequest
+     */
+    url: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateWebhookRequest
+     */
+    name?: string;
+}
+
+/**
+ * Check if a given object implements the CreateWebhookRequest interface.
+ */
+export function instanceOfCreateWebhookRequest(value: object): value is CreateWebhookRequest {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    return true;
+}
+
+export function CreateWebhookRequestFromJSON(json: any): CreateWebhookRequest {
+    return CreateWebhookRequestFromJSONTyped(json, false);
+}
+
+export function CreateWebhookRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateWebhookRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'url': json['url'],
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+
+export function CreateWebhookRequestToJSON(json: any): CreateWebhookRequest {
+    return CreateWebhookRequestToJSONTyped(json, false);
+}
+
+export function CreateWebhookRequestToJSONTyped(value?: CreateWebhookRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'url': value['url'],
+        'name': value['name'],
+    };
+}
+

package/src/models/ErrorBody.ts

@@ -0,0 +1,116 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ErrorBody
+ */
+export interface ErrorBody {
+    /**
+     * 
+     * @type {ErrorBodyCodeEnum}
+     * @memberof ErrorBody
+     */
+    code: ErrorBodyCodeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ErrorBody
+     */
+    message: string;
+    /**
+     * True for rate_limited, capacity_exceeded, and internal_error.
+     * Clients should retry with exponential backoff when true.
+     * 
+     * @type {boolean}
+     * @memberof ErrorBody
+     */
+    retryable: boolean;
+    /**
+     * Server-assigned request ID for correlation with logs.
+     * @type {string}
+     * @memberof ErrorBody
+     */
+    request_id?: string;
+}
+
+/**
+* @export
+* @enum {string}
+*/
+export enum ErrorBodyCodeEnum {
+    VALIDATION_ERROR = 'validation_error',
+    UNAUTHORIZED = 'unauthorized',
+    FORBIDDEN = 'forbidden',
+    NOT_FOUND = 'not_found',
+    CONFLICT = 'conflict',
+    RATE_LIMITED = 'rate_limited',
+    QUOTA_EXCEEDED = 'quota_exceeded',
+    CAPACITY_EXCEEDED = 'capacity_exceeded',
+    SOURCE_INVALID = 'source_invalid',
+    SOURCE_UNSUPPORTED = 'source_unsupported',
+    JOB_NOT_CANCELABLE = 'job_not_cancelable',
+    OUTPUT_NOT_READY = 'output_not_ready',
+    OUTPUT_PERSISTENCE_FAILED = 'output_persistence_failed',
+    INTERNAL_ERROR = 'internal_error'
+}
+
+
+/**
+ * Check if a given object implements the ErrorBody interface.
+ */
+export function instanceOfErrorBody(value: object): value is ErrorBody {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('retryable' in value) || value['retryable'] === undefined) return false;
+    return true;
+}
+
+export function ErrorBodyFromJSON(json: any): ErrorBody {
+    return ErrorBodyFromJSONTyped(json, false);
+}
+
+export function ErrorBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'],
+        'retryable': json['retryable'],
+        'request_id': json['request_id'] == null ? undefined : json['request_id'],
+    };
+}
+
+export function ErrorBodyToJSON(json: any): ErrorBody {
+    return ErrorBodyToJSONTyped(json, false);
+}
+
+export function ErrorBodyToJSONTyped(value?: ErrorBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'retryable': value['retryable'],
+        'request_id': value['request_id'],
+    };
+}
+

package/src/models/ErrorEnvelope.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ErrorBody } from './ErrorBody';
+import {
+    ErrorBodyFromJSON,
+    ErrorBodyFromJSONTyped,
+    ErrorBodyToJSON,
+    ErrorBodyToJSONTyped,
+} from './ErrorBody';
+
+/**
+ * 
+ * @export
+ * @interface ErrorEnvelope
+ */
+export interface ErrorEnvelope {
+    /**
+     * 
+     * @type {ErrorBody}
+     * @memberof ErrorEnvelope
+     */
+    error: ErrorBody;
+}
+
+/**
+ * Check if a given object implements the ErrorEnvelope interface.
+ */
+export function instanceOfErrorEnvelope(value: object): value is ErrorEnvelope {
+    if (!('error' in value) || value['error'] === undefined) return false;
+    return true;
+}
+
+export function ErrorEnvelopeFromJSON(json: any): ErrorEnvelope {
+    return ErrorEnvelopeFromJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelope {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'error': ErrorBodyFromJSON(json['error']),
+    };
+}
+
+export function ErrorEnvelopeToJSON(json: any): ErrorEnvelope {
+    return ErrorEnvelopeToJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeToJSONTyped(value?: ErrorEnvelope | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error': ErrorBodyToJSON(value['error']),
+    };
+}
+

package/src/models/JobOutputInfo.ts

@@ -0,0 +1,149 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface JobOutputInfo
+ */
+export interface JobOutputInfo {
+    /**
+     * 
+     * @type {JobOutputInfoStateEnum}
+     * @memberof JobOutputInfo
+     */
+    state: JobOutputInfoStateEnum;
+    /**
+     * Output container format ("mp4" or "mkv").
+     * @type {string}
+     * @memberof JobOutputInfo
+     */
+    container: string;
+    /**
+     * Whether the output file actually contains audio.
+     * Reflects the muxed result, not the request flag — a
+     * video-only source with audio requested will report false.
+     * 
+     * @type {boolean}
+     * @memberof JobOutputInfo
+     */
+    audio: boolean;
+    /**
+     * Customer-requested output height, echoed back. Null when the
+     * job ran at source dimensions (passthrough).
+     * 
+     * @type {number}
+     * @memberof JobOutputInfo
+     */
+    target_height?: number;
+    /**
+     * Actual encoded output width in pixels (post-ffprobe). Null until
+     * the job completes or if the probe failed.
+     * 
+     * @type {number}
+     * @memberof JobOutputInfo
+     */
+    width?: number;
+    /**
+     * Actual encoded output height in pixels. See `width`.
+     * @type {number}
+     * @memberof JobOutputInfo
+     */
+    height?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobOutputInfo
+     */
+    bytes?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof JobOutputInfo
+     */
+    sha256?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof JobOutputInfo
+     */
+    retention_expires_at?: Date;
+}
+
+/**
+* @export
+* @enum {string}
+*/
+export enum JobOutputInfoStateEnum {
+    PENDING = 'pending',
+    AVAILABLE = 'available'
+}
+
+
+/**
+ * Check if a given object implements the JobOutputInfo interface.
+ */
+export function instanceOfJobOutputInfo(value: object): value is JobOutputInfo {
+    if (!('state' in value) || value['state'] === undefined) return false;
+    if (!('container' in value) || value['container'] === undefined) return false;
+    if (!('audio' in value) || value['audio'] === undefined) return false;
+    return true;
+}
+
+export function JobOutputInfoFromJSON(json: any): JobOutputInfo {
+    return JobOutputInfoFromJSONTyped(json, false);
+}
+
+export function JobOutputInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobOutputInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'state': json['state'],
+        'container': json['container'],
+        'audio': json['audio'],
+        'target_height': json['target_height'] == null ? undefined : json['target_height'],
+        'width': json['width'] == null ? undefined : json['width'],
+        'height': json['height'] == null ? undefined : json['height'],
+        'bytes': json['bytes'] == null ? undefined : json['bytes'],
+        'sha256': json['sha256'] == null ? undefined : json['sha256'],
+        'retention_expires_at': json['retention_expires_at'] == null ? undefined : (new Date(json['retention_expires_at'])),
+    };
+}
+
+export function JobOutputInfoToJSON(json: any): JobOutputInfo {
+    return JobOutputInfoToJSONTyped(json, false);
+}
+
+export function JobOutputInfoToJSONTyped(value?: JobOutputInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'state': value['state'],
+        'container': value['container'],
+        'audio': value['audio'],
+        'target_height': value['target_height'],
+        'width': value['width'],
+        'height': value['height'],
+        'bytes': value['bytes'],
+        'sha256': value['sha256'],
+        'retention_expires_at': value['retention_expires_at'] == null ? value['retention_expires_at'] : value['retention_expires_at'].toISOString(),
+    };
+}
+

package/src/models/JobProfile.ts

@@ -0,0 +1,76 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Encoding profile ID. Coffee-themed naming: prep time maps to encode speed,
+ * bare name is the 8-bit default (universal decoder compatibility),
+ * `-10bit` suffix opts into HEVC Main10 for higher-quality playback on
+ * newer decoders.
+ * 
+ * **8-bit (default):**
+ * - `sophon-espresso` — fastest, lowest compression
+ * - `sophon-cortado` — balanced speed and quality
+ * - `sophon-americano` — slowest, highest compression
+ * 
+ * **10-bit (HEVC Main10):**
+ * - `sophon-espresso-10bit`
+ * - `sophon-cortado-10bit`
+ * - `sophon-americano-10bit`
+ * 
+ * **Adaptive dispatcher:**
+ * - `sophon-auto` — public opt-in profile. The worker classifies
+ *   the source and records the concrete `effective_profile_id` on
+ *   the job once dispatch resolves.
+ * 
+ * @export
+ * @enum {string}
+ */
+export enum JobProfile {
+    SOPHON_ESPRESSO = 'sophon-espresso',
+    SOPHON_CORTADO = 'sophon-cortado',
+    SOPHON_AMERICANO = 'sophon-americano',
+    SOPHON_ESPRESSO_10BIT = 'sophon-espresso-10bit',
+    SOPHON_CORTADO_10BIT = 'sophon-cortado-10bit',
+    SOPHON_AMERICANO_10BIT = 'sophon-americano-10bit',
+    SOPHON_AUTO = 'sophon-auto'
+}
+
+
+export function instanceOfJobProfile(value: any): boolean {
+    for (const key in JobProfile) {
+        if (Object.prototype.hasOwnProperty.call(JobProfile, key)) {
+            if (JobProfile[key as keyof typeof JobProfile] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function JobProfileFromJSON(json: any): JobProfile {
+    return JobProfileFromJSONTyped(json, false);
+}
+
+export function JobProfileFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobProfile {
+    return json as JobProfile;
+}
+
+export function JobProfileToJSON(value?: JobProfile | null): any {
+    return value as any;
+}
+
+export function JobProfileToJSONTyped(value: any, ignoreDiscriminator: boolean): JobProfile {
+    return value as JobProfile;
+}
+

package/src/models/JobProgress.ts

@@ -0,0 +1,133 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { JobStatus } from './JobStatus';
+import {
+    JobStatusFromJSON,
+    JobStatusFromJSONTyped,
+    JobStatusToJSON,
+    JobStatusToJSONTyped,
+} from './JobStatus';
+
+/**
+ * 
+ * @export
+ * @interface JobProgress
+ */
+export interface JobProgress {
+    /**
+     * Current processing stage label (e.g. "probing", "encoding", "muxing").
+     * @type {string}
+     * @memberof JobProgress
+     */
+    stage?: string;
+    /**
+     * Canonical pipeline phase used for progress semantics.
+     * @type {JobStatus}
+     * @memberof JobProgress
+     */
+    phase: JobStatus;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobProgress
+     */
+    percent: number;
+    /**
+     * Progress within the current phase. Null before active processing.
+     * @type {number}
+     * @memberof JobProgress
+     */
+    phase_percent?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobProgress
+     */
+    fps?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobProgress
+     */
+    eta_seconds?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobProgress
+     */
+    frames_done?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobProgress
+     */
+    frames_total?: number;
+}
+
+
+
+/**
+ * Check if a given object implements the JobProgress interface.
+ */
+export function instanceOfJobProgress(value: object): value is JobProgress {
+    if (!('phase' in value) || value['phase'] === undefined) return false;
+    if (!('percent' in value) || value['percent'] === undefined) return false;
+    return true;
+}
+
+export function JobProgressFromJSON(json: any): JobProgress {
+    return JobProgressFromJSONTyped(json, false);
+}
+
+export function JobProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobProgress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'stage': json['stage'] == null ? undefined : json['stage'],
+        'phase': JobStatusFromJSON(json['phase']),
+        'percent': json['percent'],
+        'phase_percent': json['phase_percent'] == null ? undefined : json['phase_percent'],
+        'fps': json['fps'] == null ? undefined : json['fps'],
+        'eta_seconds': json['eta_seconds'] == null ? undefined : json['eta_seconds'],
+        'frames_done': json['frames_done'] == null ? undefined : json['frames_done'],
+        'frames_total': json['frames_total'] == null ? undefined : json['frames_total'],
+    };
+}
+
+export function JobProgressToJSON(json: any): JobProgress {
+    return JobProgressToJSONTyped(json, false);
+}
+
+export function JobProgressToJSONTyped(value?: JobProgress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'stage': value['stage'],
+        'phase': JobStatusToJSON(value['phase']),
+        'percent': value['percent'],
+        'phase_percent': value['phase_percent'],
+        'fps': value['fps'],
+        'eta_seconds': value['eta_seconds'],
+        'frames_done': value['frames_done'],
+        'frames_total': value['frames_total'],
+    };
+}
+