@liqhtworks/sophon-sdk 0.1.0

package/dist/esm/models/WebhookListItem.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the WebhookListItem interface.
+ */
+export function instanceOfWebhookListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    if (!('active' in value) || value['active'] === undefined)
+        return false;
+    if (!('created_at' in value) || value['created_at'] === undefined)
+        return false;
+    return true;
+}
+export function WebhookListItemFromJSON(json) {
+    return WebhookListItemFromJSONTyped(json, false);
+}
+export function WebhookListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'url': json['url'],
+        'active': json['active'],
+        'created_at': (new Date(json['created_at'])),
+    };
+}
+export function WebhookListItemToJSON(json) {
+    return WebhookListItemToJSONTyped(json, false);
+}
+export function WebhookListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'url': value['url'],
+        'active': value['active'],
+        'created_at': value['created_at'].toISOString(),
+    };
+}

package/dist/esm/models/WebhookListResponse.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 type { WebhookListItem } from './WebhookListItem';
+/**
+ *
+ * @export
+ * @interface WebhookListResponse
+ */
+export interface WebhookListResponse {
+    /**
+     *
+     * @type {Array<WebhookListItem>}
+     * @memberof WebhookListResponse
+     */
+    webhooks: Array<WebhookListItem>;
+}
+/**
+ * Check if a given object implements the WebhookListResponse interface.
+ */
+export declare function instanceOfWebhookListResponse(value: object): value is WebhookListResponse;
+export declare function WebhookListResponseFromJSON(json: any): WebhookListResponse;
+export declare function WebhookListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookListResponse;
+export declare function WebhookListResponseToJSON(json: any): WebhookListResponse;
+export declare function WebhookListResponseToJSONTyped(value?: WebhookListResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WebhookListResponse.js

@@ -0,0 +1,44 @@
+/* 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 { WebhookListItemFromJSON, WebhookListItemToJSON, } from './WebhookListItem';
+/**
+ * Check if a given object implements the WebhookListResponse interface.
+ */
+export function instanceOfWebhookListResponse(value) {
+    if (!('webhooks' in value) || value['webhooks'] === undefined)
+        return false;
+    return true;
+}
+export function WebhookListResponseFromJSON(json) {
+    return WebhookListResponseFromJSONTyped(json, false);
+}
+export function WebhookListResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'webhooks': (json['webhooks'].map(WebhookListItemFromJSON)),
+    };
+}
+export function WebhookListResponseToJSON(json) {
+    return WebhookListResponseToJSONTyped(json, false);
+}
+export function WebhookListResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'webhooks': (value['webhooks'].map(WebhookListItemToJSON)),
+    };
+}

package/dist/esm/models/WebhookResponse.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface WebhookResponse
+ */
+export interface WebhookResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof WebhookResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WebhookResponse
+     */
+    url: string;
+    /**
+     * HMAC signing secret (64-char hex string, 32 random bytes).
+     * Only returned on creation. Use to verify webhook delivery signatures.
+     *
+     * @type {string}
+     * @memberof WebhookResponse
+     */
+    secret: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof WebhookResponse
+     */
+    active: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof WebhookResponse
+     */
+    created_at: Date;
+}
+/**
+ * Check if a given object implements the WebhookResponse interface.
+ */
+export declare function instanceOfWebhookResponse(value: object): value is WebhookResponse;
+export declare function WebhookResponseFromJSON(json: any): WebhookResponse;
+export declare function WebhookResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookResponse;
+export declare function WebhookResponseToJSON(json: any): WebhookResponse;
+export declare function WebhookResponseToJSONTyped(value?: WebhookResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WebhookResponse.js

@@ -0,0 +1,59 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the WebhookResponse interface.
+ */
+export function instanceOfWebhookResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    if (!('secret' in value) || value['secret'] === undefined)
+        return false;
+    if (!('active' in value) || value['active'] === undefined)
+        return false;
+    if (!('created_at' in value) || value['created_at'] === undefined)
+        return false;
+    return true;
+}
+export function WebhookResponseFromJSON(json) {
+    return WebhookResponseFromJSONTyped(json, false);
+}
+export function WebhookResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'url': json['url'],
+        'secret': json['secret'],
+        'active': json['active'],
+        'created_at': (new Date(json['created_at'])),
+    };
+}
+export function WebhookResponseToJSON(json) {
+    return WebhookResponseToJSONTyped(json, false);
+}
+export function WebhookResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'url': value['url'],
+        'secret': value['secret'],
+        'active': value['active'],
+        'created_at': value['created_at'].toISOString(),
+    };
+}

package/dist/esm/models/index.d.ts

@@ -0,0 +1,25 @@
+export * from './CompleteUploadResponse';
+export * from './CreateJobOutputOptions';
+export * from './CreateJobRequest';
+export * from './CreateUploadRequest';
+export * from './CreateUploadResponse';
+export * from './CreateWebhookRequest';
+export * from './ErrorBody';
+export * from './ErrorEnvelope';
+export * from './JobOutputInfo';
+export * from './JobProfile';
+export * from './JobProgress';
+export * from './JobResponse';
+export * from './JobSourceInfo';
+export * from './JobSourceType';
+export * from './JobStatus';
+export * from './ListJobsResponse';
+export * from './OutputContainer';
+export * from './ReadyResponse';
+export * from './UploadJobSource';
+export * from './UploadPartResponse';
+export * from './UploadStatusResponse';
+export * from './WebhookDeliveryPayload';
+export * from './WebhookListItem';
+export * from './WebhookListResponse';
+export * from './WebhookResponse';

package/dist/esm/models/index.js

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './CompleteUploadResponse';
+export * from './CreateJobOutputOptions';
+export * from './CreateJobRequest';
+export * from './CreateUploadRequest';
+export * from './CreateUploadResponse';
+export * from './CreateWebhookRequest';
+export * from './ErrorBody';
+export * from './ErrorEnvelope';
+export * from './JobOutputInfo';
+export * from './JobProfile';
+export * from './JobProgress';
+export * from './JobResponse';
+export * from './JobSourceInfo';
+export * from './JobSourceType';
+export * from './JobStatus';
+export * from './ListJobsResponse';
+export * from './OutputContainer';
+export * from './ReadyResponse';
+export * from './UploadJobSource';
+export * from './UploadPartResponse';
+export * from './UploadStatusResponse';
+export * from './WebhookDeliveryPayload';
+export * from './WebhookListItem';
+export * from './WebhookListResponse';
+export * from './WebhookResponse';

package/dist/esm/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * 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.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}