@liqhtworks/sophon-sdk 0.1.0

package/docs/WebhookListItem.md

@@ -0,0 +1,40 @@
+
+# WebhookListItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`url` | string
+`active` | boolean
+`created_at` | Date
+
+## Example
+
+```typescript
+import type { WebhookListItem } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "url": null,
+  "active": null,
+  "created_at": null,
+} satisfies WebhookListItem
+
+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 WebhookListItem
+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/WebhookListResponse.md

@@ -0,0 +1,34 @@
+
+# WebhookListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`webhooks` | [Array<WebhookListItem>](WebhookListItem.md)
+
+## Example
+
+```typescript
+import type { WebhookListResponse } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "webhooks": null,
+} satisfies WebhookListResponse
+
+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 WebhookListResponse
+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/WebhookResponse.md

@@ -0,0 +1,42 @@
+
+# WebhookResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`url` | string
+`secret` | string
+`active` | boolean
+`created_at` | Date
+
+## Example
+
+```typescript
+import type { WebhookResponse } from '@liqhtworks/sophon-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": wh_abc123def456,
+  "url": null,
+  "secret": null,
+  "active": null,
+  "created_at": null,
+} satisfies WebhookResponse
+
+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 WebhookResponse
+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/WebhooksApi.md

@@ -0,0 +1,235 @@
+# WebhooksApi
+
+All URIs are relative to *https://api.liqhtworks.xyz*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createWebhook**](WebhooksApi.md#createwebhookoperation) | **POST** /v1/webhooks | Register a webhook endpoint |
+| [**deleteWebhook**](WebhooksApi.md#deletewebhook) | **DELETE** /v1/webhooks/{id} | Soft-delete a webhook endpoint |
+| [**listWebhooks**](WebhooksApi.md#listwebhooks) | **GET** /v1/webhooks | List active webhook endpoints |
+
+
+
+## createWebhook
+
+> WebhookResponse createWebhook(idempotencyKey, createWebhookRequest)
+
+Register a webhook endpoint
+
+Registers an HTTPS endpoint for terminal job events and returns the HMAC signing secret once at creation time. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@liqhtworks/sophon-sdk';
+import type { CreateWebhookOperationRequest } 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 WebhooksApi(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,
+    // CreateWebhookRequest
+    createWebhookRequest: ...,
+  } satisfies CreateWebhookOperationRequest;
+
+  try {
+    const data = await api.createWebhook(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`] |
+| **createWebhookRequest** | [CreateWebhookRequest](CreateWebhookRequest.md) |  | |
+
+### Return type
+
+[**WebhookResponse**](WebhookResponse.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** | Webhook registered. The response includes the HMAC secret (shown only once). |  * X-Request-Id -  <br>  |
+| **400** | Invalid URL (non-HTTPS, private IP, userinfo, etc.). |  * X-Request-Id -  <br>  |
+| **401** | Missing or invalid credentials. |  * X-Request-Id -  <br>  |
+| **403** | Insufficient scope (requires webhooks:manage). |  * X-Request-Id -  <br>  |
+| **409** | Idempotency conflict. |  * X-Request-Id -  <br>  |
+| **429** | Rate limited. |  * 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)
+
+
+## deleteWebhook
+
+> deleteWebhook(id)
+
+Soft-delete a webhook endpoint
+
+Sets the webhook to inactive. It will no longer receive deliveries.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@liqhtworks/sophon-sdk';
+import type { DeleteWebhookRequest } 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 WebhooksApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies DeleteWebhookRequest;
+
+  try {
+    const data = await api.deleteWebhook(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** | Webhook deactivated. No content returned. |  * X-Request-Id -  <br>  |
+| **401** | Missing or invalid credentials. |  * X-Request-Id -  <br>  |
+| **403** | Insufficient scope (requires webhooks:manage). |  * X-Request-Id -  <br>  |
+| **404** | Webhook not found or already inactive. |  * 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)
+
+
+## listWebhooks
+
+> WebhookListResponse listWebhooks()
+
+List active webhook endpoints
+
+Lists active webhook endpoints for the authenticated organization. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@liqhtworks/sophon-sdk';
+import type { ListWebhooksRequest } 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 WebhooksApi(config);
+
+  try {
+    const data = await api.listWebhooks();
+    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
+
+[**WebhookListResponse**](WebhookListResponse.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** | List of active webhooks for the authenticated organization. |  * X-Request-Id -  <br>  |
+| **401** | Missing or invalid credentials. |  * X-Request-Id -  <br>  |
+| **403** | Insufficient scope (requires webhooks:manage). |  * 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/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@liqhtworks/sophon-sdk",
+  "version": "0.1.0",
+  "description": "OpenAPI client for @liqhtworks/sophon-sdk",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Liqhtworks/sophon-sdk-typescript.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  },
+  "publishConfig": {
+    "registry": "https://github.com/Liqhtworks/sophon-sdk-typescript"
+  }
+}

package/src/apis/DownloadsApi.ts

@@ -0,0 +1,114 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ErrorEnvelope,
+} from '../models/index';
+import {
+    ErrorEnvelopeFromJSON,
+    ErrorEnvelopeToJSON,
+} from '../models/index';
+
+export interface DownloadRequest {
+    token: string;
+}
+
+/**
+ * DownloadsApi - interface
+ * 
+ * @export
+ * @interface DownloadsApiInterface
+ */
+export interface DownloadsApiInterface {
+    /**
+     * Creates request options for download without sending the request
+     * @param {string} token HMAC-signed download token encoding the object key and expiry.
+     * @throws {RequiredError}
+     * @memberof DownloadsApiInterface
+     */
+    downloadRequestOpts(requestParameters: DownloadRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 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. 
+     * @summary Download an output file via signed token
+     * @param {string} token HMAC-signed download token encoding the object key and expiry.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DownloadsApiInterface
+     */
+    downloadRaw(requestParameters: DownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+
+    /**
+     * 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. 
+     * Download an output file via signed token
+     */
+    download(requestParameters: DownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+
+}
+
+/**
+ * 
+ */
+export class DownloadsApi extends runtime.BaseAPI implements DownloadsApiInterface {
+
+    /**
+     * Creates request options for download without sending the request
+     */
+    async downloadRequestOpts(requestParameters: DownloadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError(
+                'token',
+                'Required parameter "token" was null or undefined when calling download().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/downloads/{token}`;
+        urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * 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. 
+     * Download an output file via signed token
+     */
+    async downloadRaw(requestParameters: DownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.downloadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * 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. 
+     * Download an output file via signed token
+     */
+    async download(requestParameters: DownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.downloadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/HealthApi.ts

@@ -0,0 +1,160 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ReadyResponse,
+} from '../models/index';
+import {
+    ReadyResponseFromJSON,
+    ReadyResponseToJSON,
+} from '../models/index';
+
+/**
+ * HealthApi - interface
+ * 
+ * @export
+ * @interface HealthApiInterface
+ */
+export interface HealthApiInterface {
+    /**
+     * Creates request options for healthz without sending the request
+     * @throws {RequiredError}
+     * @memberof HealthApiInterface
+     */
+    healthzRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Always returns 200. Used by load balancers and orchestrators.
+     * @summary Liveness probe
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HealthApiInterface
+     */
+    healthzRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Always returns 200. Used by load balancers and orchestrators.
+     * Liveness probe
+     */
+    healthz(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for readyz without sending the request
+     * @throws {RequiredError}
+     * @memberof HealthApiInterface
+     */
+    readyzRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Returns 200 when the service is ready to accept traffic. Checks database connectivity, disk headroom (warning and critical thresholds), worker liveness, and drain state. 
+     * @summary Readiness probe
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HealthApiInterface
+     */
+    readyzRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReadyResponse>>;
+
+    /**
+     * Returns 200 when the service is ready to accept traffic. Checks database connectivity, disk headroom (warning and critical thresholds), worker liveness, and drain state. 
+     * Readiness probe
+     */
+    readyz(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReadyResponse>;
+
+}
+
+/**
+ * 
+ */
+export class HealthApi extends runtime.BaseAPI implements HealthApiInterface {
+
+    /**
+     * Creates request options for healthz without sending the request
+     */
+    async healthzRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/healthz`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Always returns 200. Used by load balancers and orchestrators.
+     * Liveness probe
+     */
+    async healthzRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.healthzRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Always returns 200. Used by load balancers and orchestrators.
+     * Liveness probe
+     */
+    async healthz(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.healthzRaw(initOverrides);
+    }
+
+    /**
+     * Creates request options for readyz without sending the request
+     */
+    async readyzRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/readyz`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns 200 when the service is ready to accept traffic. Checks database connectivity, disk headroom (warning and critical thresholds), worker liveness, and drain state. 
+     * Readiness probe
+     */
+    async readyzRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReadyResponse>> {
+        const requestOptions = await this.readyzRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReadyResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns 200 when the service is ready to accept traffic. Checks database connectivity, disk headroom (warning and critical thresholds), worker liveness, and drain state. 
+     * Readiness probe
+     */
+    async readyz(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReadyResponse> {
+        const response = await this.readyzRaw(initOverrides);
+        return await response.value();
+    }
+
+}