@liqhtworks/sophon-sdk 0.1.0

package/src/models/JobResponse.ts

@@ -0,0 +1,236 @@
+/* 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';
+import type { JobSourceInfo } from './JobSourceInfo';
+import {
+    JobSourceInfoFromJSON,
+    JobSourceInfoFromJSONTyped,
+    JobSourceInfoToJSON,
+    JobSourceInfoToJSONTyped,
+} from './JobSourceInfo';
+import type { JobProfile } from './JobProfile';
+import {
+    JobProfileFromJSON,
+    JobProfileFromJSONTyped,
+    JobProfileToJSON,
+    JobProfileToJSONTyped,
+} from './JobProfile';
+import type { JobOutputInfo } from './JobOutputInfo';
+import {
+    JobOutputInfoFromJSON,
+    JobOutputInfoFromJSONTyped,
+    JobOutputInfoToJSON,
+    JobOutputInfoToJSONTyped,
+} from './JobOutputInfo';
+import type { JobProgress } from './JobProgress';
+import {
+    JobProgressFromJSON,
+    JobProgressFromJSONTyped,
+    JobProgressToJSON,
+    JobProgressToJSONTyped,
+} from './JobProgress';
+
+/**
+ * 
+ * @export
+ * @interface JobResponse
+ */
+export interface JobResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof JobResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {JobStatus}
+     * @memberof JobResponse
+     */
+    status: JobStatus;
+    /**
+     * 
+     * @type {string}
+     * @memberof JobResponse
+     */
+    status_reason?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobResponse
+     */
+    attempt: number;
+    /**
+     * Whether the job can still be retried (attempt < max_attempts and not terminal).
+     * @type {boolean}
+     * @memberof JobResponse
+     */
+    retryable: boolean;
+    /**
+     * Public profile ID submitted by the customer. For adaptive jobs this
+     * stays `sophon-auto`; see `effective_profile_id` for the worker's
+     * resolved concrete profile.
+     * 
+     * @type {JobProfile}
+     * @memberof JobResponse
+     */
+    profile: JobProfile;
+    /**
+     * Concrete profile resolved by the worker. Omitted until dispatch
+     * resolves. On explicit-profile jobs this equals `profile`; on
+     * `sophon-auto` jobs it is an internal adaptive profile ID.
+     * 
+     * @type {string}
+     * @memberof JobResponse
+     */
+    effective_profile_id?: string;
+    /**
+     * 
+     * @type {JobSourceInfo}
+     * @memberof JobResponse
+     */
+    source: JobSourceInfo;
+    /**
+     * 
+     * @type {JobProgress}
+     * @memberof JobResponse
+     */
+    progress: JobProgress;
+    /**
+     * 
+     * @type {JobOutputInfo}
+     * @memberof JobResponse
+     */
+    output: JobOutputInfo;
+    /**
+     * Arbitrary JSON object attached to a job. Keys and values are passed
+     * through unchanged to webhook deliveries and echoed on job reads. The
+     * serialized representation must not exceed 16 KiB. Free-form; SDKs
+     * surface this as a `Record<string, unknown>` / `dict[str, Any]` /
+     * `map[string]interface{}` depending on language.
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof JobResponse
+     */
+    metadata: { [key: string]: any; };
+    /**
+     * 
+     * @type {Date}
+     * @memberof JobResponse
+     */
+    created_at: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof JobResponse
+     */
+    started_at?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof JobResponse
+     */
+    completed_at?: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof JobResponse
+     */
+    error?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the JobResponse interface.
+ */
+export function instanceOfJobResponse(value: object): value is JobResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('attempt' in value) || value['attempt'] === undefined) return false;
+    if (!('retryable' in value) || value['retryable'] === undefined) return false;
+    if (!('profile' in value) || value['profile'] === undefined) return false;
+    if (!('source' in value) || value['source'] === undefined) return false;
+    if (!('progress' in value) || value['progress'] === undefined) return false;
+    if (!('output' in value) || value['output'] === undefined) return false;
+    if (!('metadata' in value) || value['metadata'] === undefined) return false;
+    if (!('created_at' in value) || value['created_at'] === undefined) return false;
+    return true;
+}
+
+export function JobResponseFromJSON(json: any): JobResponse {
+    return JobResponseFromJSONTyped(json, false);
+}
+
+export function JobResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': JobStatusFromJSON(json['status']),
+        'status_reason': json['status_reason'] == null ? undefined : json['status_reason'],
+        'attempt': json['attempt'],
+        'retryable': json['retryable'],
+        'profile': JobProfileFromJSON(json['profile']),
+        'effective_profile_id': json['effective_profile_id'] == null ? undefined : json['effective_profile_id'],
+        'source': JobSourceInfoFromJSON(json['source']),
+        'progress': JobProgressFromJSON(json['progress']),
+        'output': JobOutputInfoFromJSON(json['output']),
+        'metadata': json['metadata'],
+        'created_at': (new Date(json['created_at'])),
+        'started_at': json['started_at'] == null ? undefined : (new Date(json['started_at'])),
+        'completed_at': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
+        'error': json['error'] == null ? undefined : json['error'],
+    };
+}
+
+export function JobResponseToJSON(json: any): JobResponse {
+    return JobResponseToJSONTyped(json, false);
+}
+
+export function JobResponseToJSONTyped(value?: JobResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': JobStatusToJSON(value['status']),
+        'status_reason': value['status_reason'],
+        'attempt': value['attempt'],
+        'retryable': value['retryable'],
+        'profile': JobProfileToJSON(value['profile']),
+        'effective_profile_id': value['effective_profile_id'],
+        'source': JobSourceInfoToJSON(value['source']),
+        'progress': JobProgressToJSON(value['progress']),
+        'output': JobOutputInfoToJSON(value['output']),
+        'metadata': value['metadata'],
+        'created_at': value['created_at'].toISOString(),
+        'started_at': value['started_at'] == null ? value['started_at'] : value['started_at'].toISOString(),
+        'completed_at': value['completed_at'] == null ? value['completed_at'] : value['completed_at'].toISOString(),
+        'error': value['error'],
+    };
+}
+

package/src/models/JobSourceInfo.ts

@@ -0,0 +1,106 @@
+/* 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 JobSourceInfo
+ */
+export interface JobSourceInfo {
+    /**
+     * Original file name of the source.
+     * @type {string}
+     * @memberof JobSourceInfo
+     */
+    name?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobSourceInfo
+     */
+    bytes?: number;
+    /**
+     * SHA-256 hex digest of the source file.
+     * @type {string}
+     * @memberof JobSourceInfo
+     */
+    sha256: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof JobSourceInfo
+     */
+    duration_seconds?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof JobSourceInfo
+     */
+    resolution?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof JobSourceInfo
+     */
+    frame_rate?: string;
+}
+
+/**
+ * Check if a given object implements the JobSourceInfo interface.
+ */
+export function instanceOfJobSourceInfo(value: object): value is JobSourceInfo {
+    if (!('sha256' in value) || value['sha256'] === undefined) return false;
+    return true;
+}
+
+export function JobSourceInfoFromJSON(json: any): JobSourceInfo {
+    return JobSourceInfoFromJSONTyped(json, false);
+}
+
+export function JobSourceInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobSourceInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'bytes': json['bytes'] == null ? undefined : json['bytes'],
+        'sha256': json['sha256'],
+        'duration_seconds': json['duration_seconds'] == null ? undefined : json['duration_seconds'],
+        'resolution': json['resolution'] == null ? undefined : json['resolution'],
+        'frame_rate': json['frame_rate'] == null ? undefined : json['frame_rate'],
+    };
+}
+
+export function JobSourceInfoToJSON(json: any): JobSourceInfo {
+    return JobSourceInfoToJSONTyped(json, false);
+}
+
+export function JobSourceInfoToJSONTyped(value?: JobSourceInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'bytes': value['bytes'],
+        'sha256': value['sha256'],
+        'duration_seconds': value['duration_seconds'],
+        'resolution': value['resolution'],
+        'frame_rate': value['frame_rate'],
+    };
+}
+

package/src/models/JobSourceType.ts

@@ -0,0 +1,51 @@
+/* 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.
+ */
+
+/**
+ * Discriminator for `JobSource` variants.
+ * @export
+ * @enum {string}
+ */
+export enum JobSourceType {
+    UPLOAD = 'upload'
+}
+
+
+export function instanceOfJobSourceType(value: any): boolean {
+    for (const key in JobSourceType) {
+        if (Object.prototype.hasOwnProperty.call(JobSourceType, key)) {
+            if (JobSourceType[key as keyof typeof JobSourceType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function JobSourceTypeFromJSON(json: any): JobSourceType {
+    return JobSourceTypeFromJSONTyped(json, false);
+}
+
+export function JobSourceTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobSourceType {
+    return json as JobSourceType;
+}
+
+export function JobSourceTypeToJSON(value?: JobSourceType | null): any {
+    return value as any;
+}
+
+export function JobSourceTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): JobSourceType {
+    return value as JobSourceType;
+}
+

package/src/models/JobStatus.ts

@@ -0,0 +1,58 @@
+/* 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.
+ */
+
+/**
+ * Lifecycle status for an encoding job.
+ * @export
+ * @enum {string}
+ */
+export enum JobStatus {
+    QUEUED = 'queued',
+    PROBING = 'probing',
+    ENCODING = 'encoding',
+    MUXING = 'muxing',
+    UPLOADING_OUTPUT = 'uploading_output',
+    COMPLETED = 'completed',
+    FAILED = 'failed',
+    CANCELED = 'canceled'
+}
+
+
+export function instanceOfJobStatus(value: any): boolean {
+    for (const key in JobStatus) {
+        if (Object.prototype.hasOwnProperty.call(JobStatus, key)) {
+            if (JobStatus[key as keyof typeof JobStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function JobStatusFromJSON(json: any): JobStatus {
+    return JobStatusFromJSONTyped(json, false);
+}
+
+export function JobStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobStatus {
+    return json as JobStatus;
+}
+
+export function JobStatusToJSON(value?: JobStatus | null): any {
+    return value as any;
+}
+
+export function JobStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): JobStatus {
+    return value as JobStatus;
+}
+

package/src/models/ListJobsResponse.ts

@@ -0,0 +1,91 @@
+/* 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 { JobResponse } from './JobResponse';
+import {
+    JobResponseFromJSON,
+    JobResponseFromJSONTyped,
+    JobResponseToJSON,
+    JobResponseToJSONTyped,
+} from './JobResponse';
+
+/**
+ * 
+ * @export
+ * @interface ListJobsResponse
+ */
+export interface ListJobsResponse {
+    /**
+     * 
+     * @type {Array<JobResponse>}
+     * @memberof ListJobsResponse
+     */
+    jobs: Array<JobResponse>;
+    /**
+     * Opaque cursor for the next page. Null when no more results.
+     * @type {string}
+     * @memberof ListJobsResponse
+     */
+    next_cursor?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ListJobsResponse
+     */
+    has_more: boolean;
+}
+
+/**
+ * Check if a given object implements the ListJobsResponse interface.
+ */
+export function instanceOfListJobsResponse(value: object): value is ListJobsResponse {
+    if (!('jobs' in value) || value['jobs'] === undefined) return false;
+    if (!('has_more' in value) || value['has_more'] === undefined) return false;
+    return true;
+}
+
+export function ListJobsResponseFromJSON(json: any): ListJobsResponse {
+    return ListJobsResponseFromJSONTyped(json, false);
+}
+
+export function ListJobsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListJobsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'jobs': ((json['jobs'] as Array<any>).map(JobResponseFromJSON)),
+        'next_cursor': json['next_cursor'] == null ? undefined : json['next_cursor'],
+        'has_more': json['has_more'],
+    };
+}
+
+export function ListJobsResponseToJSON(json: any): ListJobsResponse {
+    return ListJobsResponseToJSONTyped(json, false);
+}
+
+export function ListJobsResponseToJSONTyped(value?: ListJobsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'jobs': ((value['jobs'] as Array<any>).map(JobResponseToJSON)),
+        'next_cursor': value['next_cursor'],
+        'has_more': value['has_more'],
+    };
+}
+

package/src/models/OutputContainer.ts

@@ -0,0 +1,54 @@
+/* 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.
+ */
+
+/**
+ * Output container format. MP4 is widely compatible; MKV
+ * supports a broader range of audio codecs for passthrough.
+ * 
+ * @export
+ * @enum {string}
+ */
+export enum OutputContainer {
+    MP4 = 'mp4',
+    MKV = 'mkv'
+}
+
+
+export function instanceOfOutputContainer(value: any): boolean {
+    for (const key in OutputContainer) {
+        if (Object.prototype.hasOwnProperty.call(OutputContainer, key)) {
+            if (OutputContainer[key as keyof typeof OutputContainer] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function OutputContainerFromJSON(json: any): OutputContainer {
+    return OutputContainerFromJSONTyped(json, false);
+}
+
+export function OutputContainerFromJSONTyped(json: any, ignoreDiscriminator: boolean): OutputContainer {
+    return json as OutputContainer;
+}
+
+export function OutputContainerToJSON(value?: OutputContainer | null): any {
+    return value as any;
+}
+
+export function OutputContainerToJSONTyped(value: any, ignoreDiscriminator: boolean): OutputContainer {
+    return value as OutputContainer;
+}
+

package/src/models/ReadyResponse.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';
+/**
+ * 
+ * @export
+ * @interface ReadyResponse
+ */
+export interface ReadyResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ReadyResponse
+     */
+    ready: boolean;
+    /**
+     * Names of failed readiness checks (database, disk_critical, draining, workers_dead).
+     * @type {Array<string>}
+     * @memberof ReadyResponse
+     */
+    checks_failed?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the ReadyResponse interface.
+ */
+export function instanceOfReadyResponse(value: object): value is ReadyResponse {
+    if (!('ready' in value) || value['ready'] === undefined) return false;
+    return true;
+}
+
+export function ReadyResponseFromJSON(json: any): ReadyResponse {
+    return ReadyResponseFromJSONTyped(json, false);
+}
+
+export function ReadyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReadyResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'ready': json['ready'],
+        'checks_failed': json['checks_failed'] == null ? undefined : json['checks_failed'],
+    };
+}
+
+export function ReadyResponseToJSON(json: any): ReadyResponse {
+    return ReadyResponseToJSONTyped(json, false);
+}
+
+export function ReadyResponseToJSONTyped(value?: ReadyResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'ready': value['ready'],
+        'checks_failed': value['checks_failed'],
+    };
+}
+