@liqhtworks/sophon-sdk 0.1.0

package/docs/CompleteUploadResponse.md

@@ -0,0 +1,40 @@
+
+# CompleteUploadResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`sha256` | string
+`bytes` | number
+
+## Example
+
+```typescript
+import type { CompleteUploadResponse } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "sha256": null,
+  "bytes": null,
+} satisfies CompleteUploadResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CompleteUploadResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateJobOutputOptions.md

@@ -0,0 +1,39 @@
+
+# CreateJobOutputOptions
+
+Optional output shaping knobs for a new job.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`container` | [OutputContainer](OutputContainer.md)
+`audio` | boolean
+`target_height` | number
+
+## Example
+
+```typescript
+import type { CreateJobOutputOptions } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "container": null,
+  "audio": null,
+  "target_height": 1080,
+} satisfies CreateJobOutputOptions
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateJobOutputOptions
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateJobRequest.md

@@ -0,0 +1,42 @@
+
+# CreateJobRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`source` | [UploadJobSource](UploadJobSource.md)
+`profile` | [JobProfile](JobProfile.md)
+`output` | [CreateJobOutputOptions](CreateJobOutputOptions.md)
+`webhook_ids` | Array<string>
+`metadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { CreateJobRequest } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "source": null,
+  "profile": null,
+  "output": null,
+  "webhook_ids": null,
+  "metadata": null,
+} satisfies CreateJobRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateJobRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateUploadRequest.md

@@ -0,0 +1,38 @@
+
+# CreateUploadRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`file_name` | string
+`file_size` | number
+`mime_type` | string
+
+## Example
+
+```typescript
+import type { CreateUploadRequest } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "file_name": null,
+  "file_size": null,
+  "mime_type": null,
+} satisfies CreateUploadRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateUploadRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateUploadResponse.md

@@ -0,0 +1,40 @@
+
+# CreateUploadResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`chunk_size` | number
+`total_chunks` | number
+`expires_at` | Date
+
+## Example
+
+```typescript
+import type { CreateUploadResponse } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": upl_abc123def456,
+  "chunk_size": null,
+  "total_chunks": null,
+  "expires_at": null,
+} satisfies CreateUploadResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateUploadResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateWebhookRequest.md

@@ -0,0 +1,36 @@
+
+# CreateWebhookRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { CreateWebhookRequest } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": null,
+  "name": null,
+} satisfies CreateWebhookRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateWebhookRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DownloadsApi.md

@@ -0,0 +1,78 @@
+# DownloadsApi
+
+All URIs are relative to *https://api.liqhtworks.xyz*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**download**](DownloadsApi.md#download) | **GET** /v1/downloads/{token} | Download an output file via signed token |
+
+
+
+## download
+
+> Blob download(token)
+
+Download an output file via signed token
+
+Serves the encoded output file. No Authorization header required -- the HMAC-signed token (generated by GET /v1/jobs/{id}/output) IS the credential. Tokens expire after 24 hours. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DownloadsApi,
+} from '@liqhtworks/sophon-sdk';
+import type { DownloadRequest } from '@liqhtworks/sophon-sdk';
+
+async function example() {
+  console.log("🚀 Testing @liqhtworks/sophon-sdk SDK...");
+  const api = new DownloadsApi();
+
+  const body = {
+    // string | HMAC-signed download token encoding the object key and expiry.
+    token: token_example,
+  } satisfies DownloadRequest;
+
+  try {
+    const data = await api.download(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **token** | `string` | HMAC-signed download token encoding the object key and expiry. | [Defaults to `undefined`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `video/mp4`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | File stream. |  * Content-Disposition - attachment; filename&#x3D;\&quot;&lt;output-filename&gt;\&quot; <br>  * Content-Type - video/mp4 <br>  * Content-Length -  <br>  * X-Request-Id -  <br>  |
+| **403** | Invalid or expired download token. |  * X-Request-Id -  <br>  |
+| **404** | Output file not found on disk. |  * X-Request-Id -  <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/ErrorBody.md

@@ -0,0 +1,40 @@
+
+# ErrorBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+`retryable` | boolean
+`request_id` | string
+
+## Example
+
+```typescript
+import type { ErrorBody } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "message": null,
+  "retryable": null,
+  "request_id": null,
+} satisfies ErrorBody
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ErrorBody
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ErrorEnvelope.md

@@ -0,0 +1,34 @@
+
+# ErrorEnvelope
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | [ErrorBody](ErrorBody.md)
+
+## Example
+
+```typescript
+import type { ErrorEnvelope } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+} satisfies ErrorEnvelope
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ErrorEnvelope
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/HealthApi.md

@@ -0,0 +1,129 @@
+# HealthApi
+
+All URIs are relative to *https://api.liqhtworks.xyz*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**healthz**](HealthApi.md#healthz) | **GET** /healthz | Liveness probe |
+| [**readyz**](HealthApi.md#readyz) | **GET** /readyz | Readiness probe |
+
+
+
+## healthz
+
+> healthz()
+
+Liveness probe
+
+Always returns 200. Used by load balancers and orchestrators.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  HealthApi,
+} from '@liqhtworks/sophon-sdk';
+import type { HealthzRequest } from '@liqhtworks/sophon-sdk';
+
+async function example() {
+  console.log("🚀 Testing @liqhtworks/sophon-sdk SDK...");
+  const api = new HealthApi();
+
+  try {
+    const data = await api.healthz();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service is alive. |  * X-Request-Id -  <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## readyz
+
+> ReadyResponse readyz()
+
+Readiness probe
+
+Returns 200 when the service is ready to accept traffic. Checks database connectivity, disk headroom (warning and critical thresholds), worker liveness, and drain state. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  HealthApi,
+} from '@liqhtworks/sophon-sdk';
+import type { ReadyzRequest } from '@liqhtworks/sophon-sdk';
+
+async function example() {
+  console.log("🚀 Testing @liqhtworks/sophon-sdk SDK...");
+  const api = new HealthApi();
+
+  try {
+    const data = await api.readyz();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ReadyResponse**](ReadyResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | All readiness checks passed. |  * X-Request-Id -  <br>  |
+| **503** | One or more readiness checks failed. |  * X-Request-Id -  <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/JobOutputInfo.md

@@ -0,0 +1,50 @@
+
+# JobOutputInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`state` | string
+`container` | string
+`audio` | boolean
+`target_height` | number
+`width` | number
+`height` | number
+`bytes` | number
+`sha256` | string
+`retention_expires_at` | Date
+
+## Example
+
+```typescript
+import type { JobOutputInfo } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "state": null,
+  "container": null,
+  "audio": null,
+  "target_height": 1080,
+  "width": 1920,
+  "height": 1080,
+  "bytes": null,
+  "sha256": null,
+  "retention_expires_at": null,
+} satisfies JobOutputInfo
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as JobOutputInfo
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/JobProfile.md

@@ -0,0 +1,33 @@
+
+# JobProfile
+
+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. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { JobProfile } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies JobProfile
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as JobProfile
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/JobProgress.md

@@ -0,0 +1,48 @@
+
+# JobProgress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`stage` | string
+`phase` | [JobStatus](JobStatus.md)
+`percent` | number
+`phase_percent` | number
+`fps` | number
+`eta_seconds` | number
+`frames_done` | number
+`frames_total` | number
+
+## Example
+
+```typescript
+import type { JobProgress } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "stage": null,
+  "phase": null,
+  "percent": null,
+  "phase_percent": null,
+  "fps": null,
+  "eta_seconds": null,
+  "frames_done": null,
+  "frames_total": null,
+} satisfies JobProgress
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as JobProgress
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+