ffmpeglab-sdk 0.3.5 → 0.3.7

package/docs/RendersApi.md

@@ -0,0 +1,280 @@
+# RendersApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**rendersControllerCreate**](RendersApi.md#renderscontrollercreate) | **POST** /renders |  |
+| [**rendersControllerFindAll**](RendersApi.md#renderscontrollerfindall) | **GET** /renders |  |
+| [**rendersControllerFindOne**](RendersApi.md#renderscontrollerfindone) | **GET** /renders/{id} |  |
+| [**rendersControllerRunRender**](RendersApi.md#renderscontrollerrunrender) | **PUT** /renders/run |  |
+
+
+
+## rendersControllerCreate
+
+> RenderResponse rendersControllerCreate(renderDto)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RendersApi,
+} from 'ffmpeglab-sdk';
+import type { RendersControllerCreateRequest } from 'ffmpeglab-sdk';
+
+async function example() {
+  console.log("🚀 Testing ffmpeglab-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new RendersApi(config);
+
+  const body = {
+    // RenderDto
+    renderDto: ...,
+  } satisfies RendersControllerCreateRequest;
+
+  try {
+    const data = await api.rendersControllerCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **renderDto** | [RenderDto](RenderDto.md) |  | |
+
+### Return type
+
+[**RenderResponse**](RenderResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+
+
+## rendersControllerFindAll
+
+> Array<RenderResponse> rendersControllerFindAll()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RendersApi,
+} from 'ffmpeglab-sdk';
+import type { RendersControllerFindAllRequest } from 'ffmpeglab-sdk';
+
+async function example() {
+  console.log("🚀 Testing ffmpeglab-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new RendersApi(config);
+
+  try {
+    const data = await api.rendersControllerFindAll();
+    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
+
+[**Array<RenderResponse>**](RenderResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### 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)
+
+
+## rendersControllerFindOne
+
+> RenderResponse rendersControllerFindOne(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RendersApi,
+} from 'ffmpeglab-sdk';
+import type { RendersControllerFindOneRequest } from 'ffmpeglab-sdk';
+
+async function example() {
+  console.log("🚀 Testing ffmpeglab-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new RendersApi(config);
+
+  const body = {
+    // string | The ID of the render
+    id: id_example,
+  } satisfies RendersControllerFindOneRequest;
+
+  try {
+    const data = await api.rendersControllerFindOne(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 render | [Defaults to `undefined`] |
+
+### Return type
+
+[**RenderResponse**](RenderResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### 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)
+
+
+## rendersControllerRunRender
+
+> rendersControllerRunRender(runDto)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RendersApi,
+} from 'ffmpeglab-sdk';
+import type { RendersControllerRunRenderRequest } from 'ffmpeglab-sdk';
+
+async function example() {
+  console.log("🚀 Testing ffmpeglab-sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new RendersApi(config);
+
+  const body = {
+    // RunDto
+    runDto: ...,
+  } satisfies RendersControllerRunRenderRequest;
+
+  try {
+    const data = await api.rendersControllerRunRender(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **runDto** | [RunDto](RunDto.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[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/Resize.md

@@ -0,0 +1,36 @@
+
+# Resize
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`x` | number
+`y` | number
+
+## Example
+
+```typescript
+import type { Resize } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "x": null,
+  "y": null,
+} satisfies Resize
+
+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 Resize
+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/RunDto.md

@@ -0,0 +1,34 @@
+
+# RunDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+
+## Example
+
+```typescript
+import type { RunDto } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+} satisfies RunDto
+
+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 RunDto
+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/package.json

@@ -1,41 +1,21 @@
 {
   "name": "ffmpeglab-sdk",
-  "description": "typescript client for ffmpeglab",
-  "author": "@ffmpeglab",
+  "version": "0.3.7",
+  "description": "OpenAPI client for ffmpeglab-sdk",
+  "author": "OpenAPI-Generator",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ffmpeglab/server.git"
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
   },
-  "keywords": [
-    "fetch",
-    "typescript",
-    "ffmpeg",
-    "ffmpeglab"
-  ],
-  "license": "MIT",
   "main": "./dist/index.js",
-  "type": "module",
-  "module": "./dist/index.js",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "typings": "./dist/index.d.ts",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && tsc -p tsconfig.esm.json",
     "prepare": "npm run build"
   },
-  "dependencies": {
-    "whatwg-fetch": "^3.0.0",
-    "es6-promise": "^4.2.4"
-  },
   "devDependencies": {
-    "typescript": "^5.0"
-  },
-  "version": "0.3.5"
+    "typescript": "^4.0 || ^5.0"
+  }
 }

package/src/apis/AppApi.ts

@@ -0,0 +1,84 @@
+/* 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';
+
+/**
+ * AppApi - interface
+ * 
+ * @export
+ * @interface AppApiInterface
+ */
+export interface AppApiInterface {
+    /**
+     * Creates request options for appControllerGetHello without sending the request
+     * @throws {RequiredError}
+     * @memberof AppApiInterface
+     */
+    appControllerGetHelloRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AppApiInterface
+     */
+    appControllerGetHelloRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     */
+    appControllerGetHello(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class AppApi extends runtime.BaseAPI implements AppApiInterface {
+
+    /**
+     * Creates request options for appControllerGetHello without sending the request
+     */
+    async appControllerGetHelloRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async appControllerGetHelloRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.appControllerGetHelloRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     */
+    async appControllerGetHello(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.appControllerGetHelloRaw(initOverrides);
+    }
+
+}