@liqhtworks/sophon-sdk 0.1.0

package/docs/UploadJobSource.md

@@ -0,0 +1,37 @@
+
+# UploadJobSource
+
+Source backed by a completed chunked upload session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | [JobSourceType](JobSourceType.md)
+`upload_id` | string
+
+## Example
+
+```typescript
+import type { UploadJobSource } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "upload_id": upl_01JQ8abc123,
+} satisfies UploadJobSource
+
+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 UploadJobSource
+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/UploadPartResponse.md

@@ -0,0 +1,36 @@
+
+# UploadPartResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`part_number` | number
+`received` | boolean
+
+## Example
+
+```typescript
+import type { UploadPartResponse } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "part_number": null,
+  "received": null,
+} satisfies UploadPartResponse
+
+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 UploadPartResponse
+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/UploadStatusResponse.md

@@ -0,0 +1,50 @@
+
+# UploadStatusResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`file_name` | string
+`total_chunks` | number
+`received_chunks` | Array<number>
+`expires_at` | Date
+`source_width` | number
+`source_height` | number
+`source_duration_seconds` | number
+
+## Example
+
+```typescript
+import type { UploadStatusResponse } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "file_name": null,
+  "total_chunks": null,
+  "received_chunks": null,
+  "expires_at": null,
+  "source_width": 3840,
+  "source_height": 2160,
+  "source_duration_seconds": 600.0,
+} satisfies UploadStatusResponse
+
+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 UploadStatusResponse
+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/UploadsApi.md

@@ -0,0 +1,415 @@
+# UploadsApi
+
+All URIs are relative to *https://api.liqhtworks.xyz*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cancelUpload**](UploadsApi.md#cancelupload) | **DELETE** /v1/uploads/{id} | Cancel an upload session |
+| [**completeUpload**](UploadsApi.md#completeupload) | **POST** /v1/uploads/{id}/complete | Finalize a chunked upload |
+| [**createUpload**](UploadsApi.md#createuploadoperation) | **POST** /v1/uploads | Initialize a chunked upload session |
+| [**getUpload**](UploadsApi.md#getupload) | **GET** /v1/uploads/{id} | Get upload session status |
+| [**uploadPart**](UploadsApi.md#uploadpart) | **PUT** /v1/uploads/{id}/parts/{part_number} | Upload a single chunk |
+
+
+
+## cancelUpload
+
+> cancelUpload(id)
+
+Cancel an upload session
+
+Sets the upload session to canceled and deletes staged chunks from disk. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadsApi,
+} from '@liqhtworks/sophon-sdk';
+import type { CancelUploadRequest } from '@liqhtworks/sophon-sdk';
+
+async function example() {
+  console.log("🚀 Testing @liqhtworks/sophon-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: sessionCookie
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UploadsApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies CancelUploadRequest;
+
+  try {
+    const data = await api.cancelUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[sessionCookie](../README.md#sessionCookie), [bearerApiKey](../README.md#bearerApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Upload canceled. No content returned. |  * X-Request-Id -  <br>  |
+| **401** | Missing or invalid credentials. |  * X-Request-Id -  <br>  |
+| **403** | Insufficient scope (requires uploads:write). |  * X-Request-Id -  <br>  |
+| **404** | Upload session not found. |  * 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)
+
+
+## completeUpload
+
+> CompleteUploadResponse completeUpload(id, idempotencyKey)
+
+Finalize a chunked upload
+
+Assembles all received chunks into a single file, validates size matches the declared file_size, probes with ffprobe, and transitions the session to completed. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadsApi,
+} from '@liqhtworks/sophon-sdk';
+import type { CompleteUploadRequest } from '@liqhtworks/sophon-sdk';
+
+async function example() {
+  console.log("🚀 Testing @liqhtworks/sophon-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: sessionCookie
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UploadsApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+    // string | Client-generated UUID or string for exactly-once semantics. Required on all POST endpoints. Replaying the same key with the same request body returns the original response without side effects. 
+    idempotencyKey: idempotencyKey_example,
+  } satisfies CompleteUploadRequest;
+
+  try {
+    const data = await api.completeUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **idempotencyKey** | `string` | Client-generated UUID or string for exactly-once semantics. Required on all POST endpoints. Replaying the same key with the same request body returns the original response without side effects.  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CompleteUploadResponse**](CompleteUploadResponse.md)
+
+### Authorization
+
+[sessionCookie](../README.md#sessionCookie), [bearerApiKey](../README.md#bearerApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Upload assembled and validated. |  * X-Request-Id -  <br>  |
+| **400** | Not all chunks received. |  * X-Request-Id -  <br>  |
+| **401** | Missing or invalid credentials. |  * X-Request-Id -  <br>  |
+| **403** | Insufficient scope (requires uploads:write). |  * X-Request-Id -  <br>  |
+| **404** | Upload session not found. |  * X-Request-Id -  <br>  |
+| **409** | Upload session is not in \&quot;uploading\&quot; state. |  * X-Request-Id -  <br>  |
+| **422** | Assembled file size mismatch or not a valid video file (source_invalid). |  * X-Request-Id -  <br>  |
+| **503** | Disk capacity exceeded; cannot assemble. |  * 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)
+
+
+## createUpload
+
+> CreateUploadResponse createUpload(idempotencyKey, createUploadRequest)
+
+Initialize a chunked upload session
+
+Starts a resumable source upload and returns the chunk size, chunk count, session ID, and expiration timestamp. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadsApi,
+} from '@liqhtworks/sophon-sdk';
+import type { CreateUploadOperationRequest } from '@liqhtworks/sophon-sdk';
+
+async function example() {
+  console.log("🚀 Testing @liqhtworks/sophon-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: sessionCookie
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UploadsApi(config);
+
+  const body = {
+    // string | Client-generated UUID or string for exactly-once semantics. Required on all POST endpoints. Replaying the same key with the same request body returns the original response without side effects. 
+    idempotencyKey: idempotencyKey_example,
+    // CreateUploadRequest
+    createUploadRequest: ...,
+  } satisfies CreateUploadOperationRequest;
+
+  try {
+    const data = await api.createUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **idempotencyKey** | `string` | Client-generated UUID or string for exactly-once semantics. Required on all POST endpoints. Replaying the same key with the same request body returns the original response without side effects.  | [Defaults to `undefined`] |
+| **createUploadRequest** | [CreateUploadRequest](CreateUploadRequest.md) |  | |
+
+### Return type
+
+[**CreateUploadResponse**](CreateUploadResponse.md)
+
+### Authorization
+
+[sessionCookie](../README.md#sessionCookie), [bearerApiKey](../README.md#bearerApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Upload session created. |  * X-Request-Id -  <br>  |
+| **400** | Validation error (empty file_name, zero file_size, exceeds max). |  * X-Request-Id -  <br>  |
+| **401** | Missing or invalid credentials. |  * X-Request-Id -  <br>  |
+| **403** | Insufficient scope (requires uploads:create). |  * X-Request-Id -  <br>  |
+| **409** | Idempotency conflict. |  * X-Request-Id -  <br>  |
+| **429** | Rate limited or quota exceeded. |  * X-Request-Id -  <br>  |
+| **503** | Disk capacity exceeded; uploads paused. |  * 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)
+
+
+## getUpload
+
+> UploadStatusResponse getUpload(id)
+
+Get upload session status
+
+Returns received chunks and, after assembly/probe, source dimensions and duration used by downstream budget and encoding decisions. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadsApi,
+} from '@liqhtworks/sophon-sdk';
+import type { GetUploadRequest } from '@liqhtworks/sophon-sdk';
+
+async function example() {
+  console.log("🚀 Testing @liqhtworks/sophon-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: sessionCookie
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UploadsApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies GetUploadRequest;
+
+  try {
+    const data = await api.getUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**UploadStatusResponse**](UploadStatusResponse.md)
+
+### Authorization
+
+[sessionCookie](../README.md#sessionCookie), [bearerApiKey](../README.md#bearerApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Upload session status. |  * X-Request-Id -  <br>  |
+| **401** | Missing or invalid credentials. |  * X-Request-Id -  <br>  |
+| **403** | Insufficient scope (requires uploads:read). |  * X-Request-Id -  <br>  |
+| **404** | Upload session not found. |  * 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)
+
+
+## uploadPart
+
+> UploadPartResponse uploadPart(id, partNumber, body)
+
+Upload a single chunk
+
+Streams the chunk body to disk. Part numbers are 0-indexed. Uploading the same part number again is idempotent (returns success without re-writing). 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UploadsApi,
+} from '@liqhtworks/sophon-sdk';
+import type { UploadPartRequest } from '@liqhtworks/sophon-sdk';
+
+async function example() {
+  console.log("🚀 Testing @liqhtworks/sophon-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: sessionCookie
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new UploadsApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+    // number
+    partNumber: 56,
+    // Blob
+    body: BINARY_DATA_HERE,
+  } satisfies UploadPartRequest;
+
+  try {
+    const data = await api.uploadPart(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **partNumber** | `number` |  | [Defaults to `undefined`] |
+| **body** | `Blob` |  | |
+
+### Return type
+
+[**UploadPartResponse**](UploadPartResponse.md)
+
+### Authorization
+
+[sessionCookie](../README.md#sessionCookie), [bearerApiKey](../README.md#bearerApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: `application/octet-stream`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Chunk received. |  * X-Request-Id -  <br>  |
+| **400** | Part number out of range. |  * X-Request-Id -  <br>  |
+| **401** | Missing or invalid credentials. |  * X-Request-Id -  <br>  |
+| **403** | Insufficient scope (requires uploads:write). |  * X-Request-Id -  <br>  |
+| **404** | Upload session not found. |  * X-Request-Id -  <br>  |
+| **409** | Upload session is not in \&quot;uploading\&quot; state. |  * X-Request-Id -  <br>  |
+| **503** | Disk capacity exceeded. |  * 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/WebhookDeliveryPayload.md

@@ -0,0 +1,45 @@
+
+# WebhookDeliveryPayload
+
+Payload delivered to registered webhook endpoints on terminal job events. Signed with HMAC-SHA256 over `\"{timestamp}.{raw_body}\"` using the per-webhook secret. Consumers must verify the signature before processing. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`event_id` | string
+`type` | string
+`timestamp` | Date
+`job_id` | string
+`status` | string
+`metadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { WebhookDeliveryPayload } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "event_id": evt_01JQabc123,
+  "type": null,
+  "timestamp": null,
+  "job_id": job_01JQ8C4K4W6YQ7M4M0A5K9T6RF,
+  "status": null,
+  "metadata": null,
+} satisfies WebhookDeliveryPayload
+
+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 WebhookDeliveryPayload
+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/WebhookEventsApi.md

@@ -0,0 +1,91 @@
+# WebhookEventsApi
+
+All URIs are relative to *https://api.liqhtworks.xyz*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**receiveJobTerminalWebhook**](WebhookEventsApi.md#receivejobterminalwebhook) | **POST** /jobTerminalEvent | Receive a terminal job webhook |
+
+
+
+## receiveJobTerminalWebhook
+
+> receiveJobTerminalWebhook(xTurboSignature256, xTurboEventId, xTurboTimestamp, webhookDeliveryPayload)
+
+Receive a terminal job webhook
+
+Outbound webhook delivery sent to registered webhook endpoints when a job reaches `completed`, `failed`, or `canceled`. Consumers should verify `X-Turbo-Signature-256` before processing. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhookEventsApi,
+} from '@liqhtworks/sophon-sdk';
+import type { ReceiveJobTerminalWebhookRequest } from '@liqhtworks/sophon-sdk';
+
+async function example() {
+  console.log("🚀 Testing @liqhtworks/sophon-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: sessionCookie
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerApiKey
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WebhookEventsApi(config);
+
+  const body = {
+    // string | `sha256={hex}` — HMAC-SHA256 of `\"{X-Turbo-Timestamp}.{raw_body}\"` using the webhook\'s secret key. 
+    xTurboSignature256: sha256=abc123def456...,
+    // string | Unique event ID for consumer deduplication.
+    xTurboEventId: evt_01JQabc123,
+    // Date | Timestamp used in signature computation. Check for replay.
+    xTurboTimestamp: 2013-10-20T19:20:30+01:00,
+    // WebhookDeliveryPayload
+    webhookDeliveryPayload: ...,
+  } satisfies ReceiveJobTerminalWebhookRequest;
+
+  try {
+    const data = await api.receiveJobTerminalWebhook(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xTurboSignature256** | `string` | `sha256={hex}` — HMAC-SHA256 of `\"{X-Turbo-Timestamp}.{raw_body}\"` using the webhook\'s secret key.  | [Defaults to `undefined`] |
+| **xTurboEventId** | `string` | Unique event ID for consumer deduplication. | [Defaults to `undefined`] |
+| **xTurboTimestamp** | `Date` | Timestamp used in signature computation. Check for replay. | [Defaults to `undefined`] |
+| **webhookDeliveryPayload** | [WebhookDeliveryPayload](WebhookDeliveryPayload.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[sessionCookie](../README.md#sessionCookie), [bearerApiKey](../README.md#bearerApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Webhook accepted by the consumer. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+