@liqhtworks/sophon-sdk 0.1.0

package/dist/apis/WebhooksApi.js

@@ -0,0 +1,152 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhooksApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class WebhooksApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createWebhook without sending the request
+     */
+    async createWebhookRequestOpts(requestParameters) {
+        if (requestParameters['idempotencyKey'] == null) {
+            throw new runtime.RequiredError('idempotencyKey', 'Required parameter "idempotencyKey" was null or undefined when calling createWebhook().');
+        }
+        if (requestParameters['createWebhookRequest'] == null) {
+            throw new runtime.RequiredError('createWebhookRequest', 'Required parameter "createWebhookRequest" was null or undefined when calling createWebhook().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerApiKey", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/webhooks`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateWebhookRequestToJSON)(requestParameters['createWebhookRequest']),
+        };
+    }
+    /**
+     * Registers an HTTPS endpoint for terminal job events and returns the HMAC signing secret once at creation time.
+     * Register a webhook endpoint
+     */
+    async createWebhookRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createWebhookRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WebhookResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Registers an HTTPS endpoint for terminal job events and returns the HMAC signing secret once at creation time.
+     * Register a webhook endpoint
+     */
+    async createWebhook(requestParameters, initOverrides) {
+        const response = await this.createWebhookRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for deleteWebhook without sending the request
+     */
+    async deleteWebhookRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteWebhook().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerApiKey", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/webhooks/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Sets the webhook to inactive. It will no longer receive deliveries.
+     * Soft-delete a webhook endpoint
+     */
+    async deleteWebhookRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.deleteWebhookRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Sets the webhook to inactive. It will no longer receive deliveries.
+     * Soft-delete a webhook endpoint
+     */
+    async deleteWebhook(requestParameters, initOverrides) {
+        await this.deleteWebhookRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Creates request options for listWebhooks without sending the request
+     */
+    async listWebhooksRequestOpts() {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerApiKey", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/webhooks`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Lists active webhook endpoints for the authenticated organization.
+     * List active webhook endpoints
+     */
+    async listWebhooksRaw(initOverrides) {
+        const requestOptions = await this.listWebhooksRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WebhookListResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Lists active webhook endpoints for the authenticated organization.
+     * List active webhook endpoints
+     */
+    async listWebhooks(initOverrides) {
+        const response = await this.listWebhooksRaw(initOverrides);
+        return await response.value();
+    }
+}
+exports.WebhooksApi = WebhooksApi;

package/dist/apis/index.d.ts

@@ -0,0 +1,5 @@
+export * from './DownloadsApi';
+export * from './HealthApi';
+export * from './JobsApi';
+export * from './UploadsApi';
+export * from './WebhooksApi';

package/dist/apis/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./DownloadsApi"), exports);
+__exportStar(require("./HealthApi"), exports);
+__exportStar(require("./JobsApi"), exports);
+__exportStar(require("./UploadsApi"), exports);
+__exportStar(require("./WebhooksApi"), exports);

package/dist/esm/apis/DownloadsApi.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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';
+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 declare class DownloadsApi extends runtime.BaseAPI implements DownloadsApiInterface {
+    /**
+     * Creates request options for download without sending the request
+     */
+    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.
+     * Download an output file via signed token
+     */
+    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>;
+}

package/dist/esm/apis/DownloadsApi.js

@@ -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.
+ */
+import * as runtime from '../runtime';
+/**
+ *
+ */
+export class DownloadsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for download without sending the request
+     */
+    async downloadRequestOpts(requestParameters) {
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling download().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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, initOverrides) {
+        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, initOverrides) {
+        const response = await this.downloadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}

package/dist/esm/apis/HealthApi.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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';
+/**
+ * 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 declare class HealthApi extends runtime.BaseAPI implements HealthApiInterface {
+    /**
+     * Creates request options for healthz without sending the request
+     */
+    healthzRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Always returns 200. Used by load balancers and orchestrators.
+     * Liveness probe
+     */
+    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
+     */
+    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.
+     * Readiness probe
+     */
+    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>;
+}

package/dist/esm/apis/HealthApi.js

@@ -0,0 +1,81 @@
+/* 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 { ReadyResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class HealthApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for healthz without sending the request
+     */
+    async healthzRequestOpts() {
+        const queryParameters = {};
+        const headerParameters = {};
+        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) {
+        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) {
+        await this.healthzRaw(initOverrides);
+    }
+    /**
+     * Creates request options for readyz without sending the request
+     */
+    async readyzRequestOpts() {
+        const queryParameters = {};
+        const headerParameters = {};
+        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) {
+        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) {
+        const response = await this.readyzRaw(initOverrides);
+        return await response.value();
+    }
+}