ffmpeglab-sdk 0.3.6 → 0.3.8

package/.openapi-generator/FILES

@@ -0,0 +1,41 @@
+.gitignore
+.npmignore
+docs/AppApi.md
+docs/EditorLayer.md
+docs/EditorLayerParams.md
+docs/EditorProject.md
+docs/EditorProjectConfiguration.md
+docs/EncoderProject.md
+docs/EncoderProjectEncoding.md
+docs/Media.md
+docs/PositionParams.md
+docs/RGB.md
+docs/RenderData.md
+docs/RenderDto.md
+docs/RenderResponse.md
+docs/RendersApi.md
+docs/Resize.md
+docs/RunDto.md
+package.json
+src/apis/AppApi.ts
+src/apis/RendersApi.ts
+src/apis/index.ts
+src/index.ts
+src/models/EditorLayer.ts
+src/models/EditorLayerParams.ts
+src/models/EditorProject.ts
+src/models/EditorProjectConfiguration.ts
+src/models/EncoderProject.ts
+src/models/EncoderProjectEncoding.ts
+src/models/Media.ts
+src/models/PositionParams.ts
+src/models/RGB.ts
+src/models/RenderData.ts
+src/models/RenderDto.ts
+src/models/RenderResponse.ts
+src/models/Resize.ts
+src/models/RunDto.ts
+src/models/index.ts
+src/runtime.ts
+tsconfig.esm.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.24.0

package/.openapi-generator-ignore

@@ -0,0 +1,33 @@
+# IMPORTANT: this file is generated with the option `openapiGeneratorIgnoreList` enabled
+# (--openapi-generator-ignore-list in CLI for example) so the entries below are pre-populated based
+# on the input provided by the users and this file will be overwritten every time when the option is
+# enabled (which is the exact opposite of the default behaviour to not overwrite
+# .openapi-generator-ignore if the file exists).
+
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+
+# The following entries are pre-populated based on the input obtained via
+# the option `openapiGeneratorIgnoreList` (--openapi-generator-ignore-list in CLI for example).
+README.md

package/README.md

@@ -5,41 +5,25 @@ Welcome to ffmpeglab typescript sdk.
 
 ### Usage
 
-Below code snippet shows exemplary usage of the configuration and the API based 
-on the typical `FFmpegLab` example used for OpenAPI. 
+This simple code allows you to render a small project 
 
 ```
-import ffmpeglab from 'ffmpeglab-sdk'
+import * as ffmpeglab from 'ffmpeglab-sdk'
 
-// Covers all auth methods included in your OpenAPI yaml definition
-const authConfig: your_api.AuthMethodsConfiguration = {
-    "api_key": "YOUR_API_KEY"
-}
+const clientConfig = new ffmpeglab.Configuration({
+    accessToken:"API_KEY", 
+    basePath:"https://api.ffmpeglab.com"
+})
 
-// Implements a simple middleware to modify requests before (`pre`) they are sent
-// and after (`post`) they have been received 
-class Test implements your_api.Middleware {
-    pre(context: your_api.RequestContext): Promise<your_api.RequestContext> {
-        // Modify context here and return
-        return Promise.resolve(context);
-    }
+const client = new ffmpeglab.RendersApi(clientConfig)
 
-    post(context: your_api.ResponseContext): Promise<your_api.ResponseContext> {
-        return Promise.resolve(context);
-    }
+const renderDto = renderData as ffmpeglab.RenderDto
 
-}
+const newRender = await client.rendersControllerCreate({renderDto})
 
-// Create configuration parameter object
-const configurationParameters = {
-    httpApi: new your_api.JQueryHttpLibrary(), // Can also be ignored - default is usually fine
-    baseServer: your_api.servers[0], // First server is default
-    authMethods: authConfig, // No auth is default
-    promiseMiddleware: [new Test()],
-}
+await client.rendersControllerRunRender({runDto:{id:newRender.id}})
 
-// Convert to actual configuration
-const config = your_api.createConfiguration(configurationParameters);
+```
 
 
-```
+see [docs](https://api.ffmpeglab.com/api) for more

package/dist/apis/AppApi.d.ts

@@ -1,9 +1,51 @@
-import { BaseAPIRequestFactory } from './baseapi';
-import { Configuration } from '../configuration';
-import { RequestContext, ResponseContext, HttpInfo } from '../http/http';
-export declare class AppApiRequestFactory extends BaseAPIRequestFactory {
-    appControllerGetHello(_options?: Configuration): Promise<RequestContext>;
+/**
+ * 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 declare class AppApiResponseProcessor {
-    appControllerGetHelloWithHttpInfo(response: ResponseContext): Promise<HttpInfo<void>>;
+/**
+ *
+ */
+export declare class AppApi extends runtime.BaseAPI implements AppApiInterface {
+    /**
+     * Creates request options for appControllerGetHello without sending the request
+     */
+    appControllerGetHelloRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     */
+    appControllerGetHelloRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    appControllerGetHello(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }

package/dist/apis/AppApi.js

@@ -1,3 +1,17 @@
+"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) {
@@ -7,40 +21,44 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { BaseAPIRequestFactory } from './baseapi';
-import { HttpMethod, HttpInfo } from '../http/http';
-import { ObjectSerializer } from '../models/ObjectSerializer';
-import { ApiException } from './exception';
-import { isCodeInRange } from '../util';
-export class AppApiRequestFactory extends BaseAPIRequestFactory {
-    appControllerGetHello(_options) {
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppApi = void 0;
+const runtime = require("../runtime");
+/**
+ *
+ */
+class AppApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for appControllerGetHello without sending the request
+     */
+    appControllerGetHelloRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            let _config = _options || this.configuration;
-            const localVarPath = '/';
-            const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET);
-            requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8");
-            const defaultAuth = (_a = _config === null || _config === void 0 ? void 0 : _config.authMethods) === null || _a === void 0 ? void 0 : _a.default;
-            if (defaultAuth === null || defaultAuth === void 0 ? void 0 : defaultAuth.applySecurityAuthentication) {
-                yield (defaultAuth === null || defaultAuth === void 0 ? void 0 : defaultAuth.applySecurityAuthentication(requestContext));
-            }
-            return requestContext;
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
         });
     }
-}
-export class AppApiResponseProcessor {
-    appControllerGetHelloWithHttpInfo(response) {
+    /**
+     */
+    appControllerGetHelloRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.appControllerGetHelloRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     */
+    appControllerGetHello(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
-            if (isCodeInRange("200", response.httpStatusCode)) {
-                return new HttpInfo(response.httpStatusCode, response.headers, response.body, undefined);
-            }
-            if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
-                const body = ObjectSerializer.deserialize(ObjectSerializer.parse(yield response.body.text(), contentType), "void", "");
-                return new HttpInfo(response.httpStatusCode, response.headers, response.body, body);
-            }
-            throw new ApiException(response.httpStatusCode, "Unknown API Status Code!", yield response.getBodyAsAny(), response.headers);
+            yield this.appControllerGetHelloRaw(initOverrides);
         });
     }
 }
-//# sourceMappingURL=AppApi.js.map
+exports.AppApi = AppApi;

package/dist/apis/RendersApi.d.ts

@@ -1,17 +1,147 @@
-import { BaseAPIRequestFactory } from './baseapi';
-import { Configuration } from '../configuration';
-import { RequestContext, ResponseContext, HttpInfo } from '../http/http';
-import { RenderDto } from '../models/RenderDto';
-import { RunDto } from '../models/RunDto';
-export declare class RendersApiRequestFactory extends BaseAPIRequestFactory {
-    rendersControllerCreate(renderDto: RenderDto, _options?: Configuration): Promise<RequestContext>;
-    rendersControllerFindAll(_options?: Configuration): Promise<RequestContext>;
-    rendersControllerFindOne(id: string, _options?: Configuration): Promise<RequestContext>;
-    rendersControllerRunRender(runDto: RunDto, _options?: Configuration): Promise<RequestContext>;
+/**
+ * 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 RenderDto } from '../models/RenderDto';
+import { type RenderResponse } from '../models/RenderResponse';
+import { type RunDto } from '../models/RunDto';
+export interface RendersControllerCreateRequest {
+    renderDto: RenderDto;
 }
-export declare class RendersApiResponseProcessor {
-    rendersControllerCreateWithHttpInfo(response: ResponseContext): Promise<HttpInfo<void>>;
-    rendersControllerFindAllWithHttpInfo(response: ResponseContext): Promise<HttpInfo<void>>;
-    rendersControllerFindOneWithHttpInfo(response: ResponseContext): Promise<HttpInfo<void>>;
-    rendersControllerRunRenderWithHttpInfo(response: ResponseContext): Promise<HttpInfo<void>>;
+export interface RendersControllerFindOneRequest {
+    id: string;
+}
+export interface RendersControllerRunRenderRequest {
+    runDto: RunDto;
+}
+/**
+ * RendersApi - interface
+ *
+ * @export
+ * @interface RendersApiInterface
+ */
+export interface RendersApiInterface {
+    /**
+     * Creates request options for rendersControllerCreate without sending the request
+     * @param {RenderDto} renderDto
+     * @throws {RequiredError}
+     * @memberof RendersApiInterface
+     */
+    rendersControllerCreateRequestOpts(requestParameters: RendersControllerCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @param {RenderDto} renderDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RendersApiInterface
+     */
+    rendersControllerCreateRaw(requestParameters: RendersControllerCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>>;
+    /**
+     */
+    rendersControllerCreate(requestParameters: RendersControllerCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse>;
+    /**
+     * Creates request options for rendersControllerFindAll without sending the request
+     * @throws {RequiredError}
+     * @memberof RendersApiInterface
+     */
+    rendersControllerFindAllRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RendersApiInterface
+     */
+    rendersControllerFindAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<RenderResponse>>>;
+    /**
+     */
+    rendersControllerFindAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<RenderResponse>>;
+    /**
+     * Creates request options for rendersControllerFindOne without sending the request
+     * @param {string} id The ID of the render
+     * @throws {RequiredError}
+     * @memberof RendersApiInterface
+     */
+    rendersControllerFindOneRequestOpts(requestParameters: RendersControllerFindOneRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @param {string} id The ID of the render
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RendersApiInterface
+     */
+    rendersControllerFindOneRaw(requestParameters: RendersControllerFindOneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>>;
+    /**
+     */
+    rendersControllerFindOne(requestParameters: RendersControllerFindOneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse>;
+    /**
+     * Creates request options for rendersControllerRunRender without sending the request
+     * @param {RunDto} runDto
+     * @throws {RequiredError}
+     * @memberof RendersApiInterface
+     */
+    rendersControllerRunRenderRequestOpts(requestParameters: RendersControllerRunRenderRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @param {RunDto} runDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RendersApiInterface
+     */
+    rendersControllerRunRenderRaw(requestParameters: RendersControllerRunRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    rendersControllerRunRender(requestParameters: RendersControllerRunRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class RendersApi extends runtime.BaseAPI implements RendersApiInterface {
+    /**
+     * Creates request options for rendersControllerCreate without sending the request
+     */
+    rendersControllerCreateRequestOpts(requestParameters: RendersControllerCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    rendersControllerCreateRaw(requestParameters: RendersControllerCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>>;
+    /**
+     */
+    rendersControllerCreate(requestParameters: RendersControllerCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse>;
+    /**
+     * Creates request options for rendersControllerFindAll without sending the request
+     */
+    rendersControllerFindAllRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     */
+    rendersControllerFindAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<RenderResponse>>>;
+    /**
+     */
+    rendersControllerFindAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<RenderResponse>>;
+    /**
+     * Creates request options for rendersControllerFindOne without sending the request
+     */
+    rendersControllerFindOneRequestOpts(requestParameters: RendersControllerFindOneRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    rendersControllerFindOneRaw(requestParameters: RendersControllerFindOneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RenderResponse>>;
+    /**
+     */
+    rendersControllerFindOne(requestParameters: RendersControllerFindOneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RenderResponse>;
+    /**
+     * Creates request options for rendersControllerRunRender without sending the request
+     */
+    rendersControllerRunRenderRequestOpts(requestParameters: RendersControllerRunRenderRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    rendersControllerRunRenderRaw(requestParameters: RendersControllerRunRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    rendersControllerRunRender(requestParameters: RendersControllerRunRenderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }