ffmpeglab-sdk 0.3.20 → 0.3.25

package/docs/CreatePipelineDto.md

@@ -0,0 +1,40 @@
+
+# CreatePipelineDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`title` | string
+`downsql` | string
+`upsql` | string
+`yml` | string
+
+## Example
+
+```typescript
+import type { CreatePipelineDto } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "title": null,
+  "downsql": null,
+  "upsql": null,
+  "yml": null,
+} satisfies CreatePipelineDto
+
+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 CreatePipelineDto
+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/FileListDto.md

@@ -0,0 +1,34 @@
+
+# FileListDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`list` | [Array<FileObject>](FileObject.md)
+
+## Example
+
+```typescript
+import type { FileListDto } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "list": null,
+} satisfies FileListDto
+
+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 FileListDto
+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/FileObject.md

@@ -0,0 +1,40 @@
+
+# FileObject
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`lastModified` | Date
+`eTag` | string
+`size` | number
+
+## Example
+
+```typescript
+import type { FileObject } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "lastModified": null,
+  "eTag": null,
+  "size": null,
+} satisfies FileObject
+
+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 FileObject
+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/FileResponseDto.md

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

@@ -0,0 +1,210 @@
+# FilesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**filesControllerFile**](FilesApi.md#filescontrollerfile) | **GET** /files/file/{id} |  |
+| [**filesControllerList**](FilesApi.md#filescontrollerlist) | **GET** /files/list |  |
+| [**filesControllerUpload**](FilesApi.md#filescontrollerupload) | **POST** /files/upload |  |
+
+
+
+## filesControllerFile
+
+> FileResponseDto filesControllerFile(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FilesApi,
+} from 'ffmpeglab-sdk';
+import type { FilesControllerFileRequest } 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 FilesApi(config);
+
+  const body = {
+    // string | The ID of the file
+    id: id_example,
+  } satisfies FilesControllerFileRequest;
+
+  try {
+    const data = await api.filesControllerFile(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 file | [Defaults to `undefined`] |
+
+### Return type
+
+[**FileResponseDto**](FileResponseDto.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)
+
+
+## filesControllerList
+
+> Array<FileListDto> filesControllerList()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FilesApi,
+} from 'ffmpeglab-sdk';
+import type { FilesControllerListRequest } 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 FilesApi(config);
+
+  try {
+    const data = await api.filesControllerList();
+    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<FileListDto>**](FileListDto.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)
+
+
+## filesControllerUpload
+
+> filesControllerUpload(file)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FilesApi,
+} from 'ffmpeglab-sdk';
+import type { FilesControllerUploadRequest } 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 FilesApi(config);
+
+  const body = {
+    // Blob
+    file: BINARY_DATA_HERE,
+  } satisfies FilesControllerUploadRequest;
+
+  try {
+    const data = await api.filesControllerUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **file** | `Blob` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** |  |  -  |
+
+[[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/LogPiece.md

@@ -0,0 +1,42 @@
+
+# LogPiece
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`date` | Date
+`logs` | string
+`render` | string
+`userId` | string
+
+## Example
+
+```typescript
+import type { LogPiece } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "date": null,
+  "logs": null,
+  "render": null,
+  "userId": null,
+} satisfies LogPiece
+
+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 LogPiece
+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/LogsResponse.md

@@ -0,0 +1,34 @@
+
+# LogsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`logs` | [Array<LogPiece>](LogPiece.md)
+
+## Example
+
+```typescript
+import type { LogsResponse } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "logs": null,
+} satisfies LogsResponse
+
+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 LogsResponse
+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/Pipeline.md

@@ -0,0 +1,50 @@
+
+# Pipeline
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`title` | string
+`status` | string
+`userId` | string
+`downsql` | string
+`upsql` | string
+`yml` | string
+`date` | Date
+`version` | number
+
+## Example
+
+```typescript
+import type { Pipeline } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "title": null,
+  "status": null,
+  "userId": null,
+  "downsql": null,
+  "upsql": null,
+  "yml": null,
+  "date": null,
+  "version": null,
+} satisfies Pipeline
+
+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 Pipeline
+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)
+
+