ffmpeglab-sdk 0.5.0 → 0.5.2

package/.openapi-generator/FILES

@@ -18,6 +18,7 @@ docs/Media.md
 docs/Pipeline.md
 docs/PipelinesApi.md
 docs/PositionParams.md
+docs/PublicApi.md
 docs/RGB.md
 docs/RenderData.md
 docs/RenderDto.md
@@ -33,6 +34,7 @@ docs/UpdatePipelineDto.md
 src/apis/ApiKeyApi.ts
 src/apis/FilesApi.ts
 src/apis/PipelinesApi.ts
+src/apis/PublicApi.ts
 src/apis/RendersApi.ts
 src/apis/index.ts
 src/index.ts

package/dist/apis/PublicApi.d.ts

@@ -0,0 +1,57 @@
+/**
+ * FFmpeglab
+ * FFmpeglab API
+ *
+ * The version of the OpenAPI document: 1.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 RenderResponse } from '../models/RenderResponse';
+export interface PublicControllerGetPublicRenderRequest {
+    id: string;
+}
+/**
+ * PublicApi - interface
+ *
+ * @export
+ * @interface PublicApiInterface
+ */
+export interface PublicApiInterface {
+    /**
+     * Creates request options for publicControllerGetPublicRender without sending the request
+     * @param {string} id The ID of the public render
+     * @throws {RequiredError}
+     * @memberof PublicApiInterface
+     */
+    publicControllerGetPublicRenderRequestOpts(requestParameters: PublicControllerGetPublicRenderRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @param {string} id The ID of the public render
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicApiInterface
+     */
+    publicControllerGetPublicRenderRaw(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>>;
+    /**
+     */
+    publicControllerGetPublicRender(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse>;
+}
+/**
+ *
+ */
+export declare class PublicApi extends runtime.BaseAPI implements PublicApiInterface {
+    /**
+     * Creates request options for publicControllerGetPublicRender without sending the request
+     */
+    publicControllerGetPublicRenderRequestOpts(requestParameters: PublicControllerGetPublicRenderRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    publicControllerGetPublicRenderRaw(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>>;
+    /**
+     */
+    publicControllerGetPublicRender(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse>;
+}

package/dist/apis/PublicApi.js

@@ -0,0 +1,70 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * FFmpeglab
+ * FFmpeglab API
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicApi = void 0;
+const runtime = require("../runtime");
+const RenderResponse_1 = require("../models/RenderResponse");
+/**
+ *
+ */
+class PublicApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for publicControllerGetPublicRender without sending the request
+     */
+    publicControllerGetPublicRenderRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling publicControllerGetPublicRender().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/public/renders/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     */
+    publicControllerGetPublicRenderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.publicControllerGetPublicRenderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, RenderResponse_1.RenderResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     */
+    publicControllerGetPublicRender(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.publicControllerGetPublicRenderRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.PublicApi = PublicApi;

package/dist/apis/index.d.ts

@@ -1,4 +1,5 @@
 export * from './ApiKeyApi';
 export * from './FilesApi';
 export * from './PipelinesApi';
+export * from './PublicApi';
 export * from './RendersApi';

package/dist/apis/index.js

@@ -19,4 +19,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ApiKeyApi"), exports);
 __exportStar(require("./FilesApi"), exports);
 __exportStar(require("./PipelinesApi"), exports);
+__exportStar(require("./PublicApi"), exports);
 __exportStar(require("./RendersApi"), exports);

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

@@ -0,0 +1,57 @@
+/**
+ * FFmpeglab
+ * FFmpeglab API
+ *
+ * The version of the OpenAPI document: 1.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 RenderResponse } from '../models/RenderResponse';
+export interface PublicControllerGetPublicRenderRequest {
+    id: string;
+}
+/**
+ * PublicApi - interface
+ *
+ * @export
+ * @interface PublicApiInterface
+ */
+export interface PublicApiInterface {
+    /**
+     * Creates request options for publicControllerGetPublicRender without sending the request
+     * @param {string} id The ID of the public render
+     * @throws {RequiredError}
+     * @memberof PublicApiInterface
+     */
+    publicControllerGetPublicRenderRequestOpts(requestParameters: PublicControllerGetPublicRenderRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @param {string} id The ID of the public render
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicApiInterface
+     */
+    publicControllerGetPublicRenderRaw(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>>;
+    /**
+     */
+    publicControllerGetPublicRender(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse>;
+}
+/**
+ *
+ */
+export declare class PublicApi extends runtime.BaseAPI implements PublicApiInterface {
+    /**
+     * Creates request options for publicControllerGetPublicRender without sending the request
+     */
+    publicControllerGetPublicRenderRequestOpts(requestParameters: PublicControllerGetPublicRenderRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    publicControllerGetPublicRenderRaw(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>>;
+    /**
+     */
+    publicControllerGetPublicRender(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse>;
+}

package/dist/esm/apis/PublicApi.js

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * FFmpeglab
+ * FFmpeglab API
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { RenderResponseFromJSON, } from '../models/RenderResponse';
+/**
+ *
+ */
+export class PublicApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for publicControllerGetPublicRender without sending the request
+     */
+    publicControllerGetPublicRenderRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling publicControllerGetPublicRender().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/public/renders/{id}`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     */
+    publicControllerGetPublicRenderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.publicControllerGetPublicRenderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => RenderResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     */
+    publicControllerGetPublicRender(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.publicControllerGetPublicRenderRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -1,4 +1,5 @@
 export * from './ApiKeyApi';
 export * from './FilesApi';
 export * from './PipelinesApi';
+export * from './PublicApi';
 export * from './RendersApi';

package/dist/esm/apis/index.js

@@ -3,4 +3,5 @@
 export * from './ApiKeyApi';
 export * from './FilesApi';
 export * from './PipelinesApi';
+export * from './PublicApi';
 export * from './RendersApi';

package/docs/PublicApi.md

@@ -0,0 +1,74 @@
+# PublicApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**publicControllerGetPublicRender**](PublicApi.md#publiccontrollergetpublicrender) | **GET** /public/renders/{id} |  |
+
+
+
+## publicControllerGetPublicRender
+
+> RenderResponse publicControllerGetPublicRender(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PublicApi,
+} from 'ffmpeglab-sdk';
+import type { PublicControllerGetPublicRenderRequest } from 'ffmpeglab-sdk';
+
+async function example() {
+  console.log("🚀 Testing ffmpeglab-sdk SDK...");
+  const api = new PublicApi();
+
+  const body = {
+    // string | The ID of the public render
+    id: id_example,
+  } satisfies PublicControllerGetPublicRenderRequest;
+
+  try {
+    const data = await api.publicControllerGetPublicRender(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | The ID of the public render | [Defaults to `undefined`] |
+
+### Return type
+
+[**RenderResponse**](RenderResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **0** |  |  -  |
+
+[[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

@@ -17,5 +17,5 @@
   "devDependencies": {
     "typescript": "^4.0 || ^5.0"
   },
-  "version": "0.5.0"
+  "version": "0.5.2"
 }

package/src/apis/PublicApi.ts

@@ -0,0 +1,104 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * FFmpeglab
+ * FFmpeglab API
+ *
+ * The version of the OpenAPI document: 1.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 RenderResponse,
+    RenderResponseFromJSON,
+    RenderResponseToJSON,
+} from '../models/RenderResponse';
+
+export interface PublicControllerGetPublicRenderRequest {
+    id: string;
+}
+
+/**
+ * PublicApi - interface
+ * 
+ * @export
+ * @interface PublicApiInterface
+ */
+export interface PublicApiInterface {
+    /**
+     * Creates request options for publicControllerGetPublicRender without sending the request
+     * @param {string} id The ID of the public render
+     * @throws {RequiredError}
+     * @memberof PublicApiInterface
+     */
+    publicControllerGetPublicRenderRequestOpts(requestParameters: PublicControllerGetPublicRenderRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @param {string} id The ID of the public render
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PublicApiInterface
+     */
+    publicControllerGetPublicRenderRaw(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>>;
+
+    /**
+     */
+    publicControllerGetPublicRender(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse>;
+
+}
+
+/**
+ * 
+ */
+export class PublicApi extends runtime.BaseAPI implements PublicApiInterface {
+
+    /**
+     * Creates request options for publicControllerGetPublicRender without sending the request
+     */
+    async publicControllerGetPublicRenderRequestOpts(requestParameters: PublicControllerGetPublicRenderRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling publicControllerGetPublicRender().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/public/renders/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async publicControllerGetPublicRenderRaw(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>> {
+        const requestOptions = await this.publicControllerGetPublicRenderRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RenderResponseFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async publicControllerGetPublicRender(requestParameters: PublicControllerGetPublicRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse> {
+        const response = await this.publicControllerGetPublicRenderRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -3,4 +3,5 @@
 export * from './ApiKeyApi';
 export * from './FilesApi';
 export * from './PipelinesApi';
+export * from './PublicApi';
 export * from './RendersApi';