ffmpeglab-sdk 0.3.20 → 0.3.25

package/docs/PipelinesApi.md

@@ -0,0 +1,280 @@
+# PipelinesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**pipelinesControllerCreate**](PipelinesApi.md#pipelinescontrollercreate) | **POST** /pipeline |  |
+| [**pipelinesControllerFindAll**](PipelinesApi.md#pipelinescontrollerfindall) | **GET** /pipeline |  |
+| [**pipelinesControllerFindOne**](PipelinesApi.md#pipelinescontrollerfindone) | **GET** /pipeline/{id} |  |
+| [**pipelinesControllerUpdate**](PipelinesApi.md#pipelinescontrollerupdate) | **PUT** /pipeline |  |
+
+
+
+## pipelinesControllerCreate
+
+> Pipeline pipelinesControllerCreate(createPipelineDto)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PipelinesApi,
+} from 'ffmpeglab-sdk';
+import type { PipelinesControllerCreateRequest } 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 PipelinesApi(config);
+
+  const body = {
+    // CreatePipelineDto
+    createPipelineDto: ...,
+  } satisfies PipelinesControllerCreateRequest;
+
+  try {
+    const data = await api.pipelinesControllerCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createPipelineDto** | [CreatePipelineDto](CreatePipelineDto.md) |  | |
+
+### Return type
+
+[**Pipeline**](Pipeline.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)
+
+
+## pipelinesControllerFindAll
+
+> Array<Pipeline> pipelinesControllerFindAll()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PipelinesApi,
+} from 'ffmpeglab-sdk';
+import type { PipelinesControllerFindAllRequest } 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 PipelinesApi(config);
+
+  try {
+    const data = await api.pipelinesControllerFindAll();
+    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<Pipeline>**](Pipeline.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)
+
+
+## pipelinesControllerFindOne
+
+> Pipeline pipelinesControllerFindOne(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PipelinesApi,
+} from 'ffmpeglab-sdk';
+import type { PipelinesControllerFindOneRequest } 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 PipelinesApi(config);
+
+  const body = {
+    // string | The ID of the pipeline
+    id: id_example,
+  } satisfies PipelinesControllerFindOneRequest;
+
+  try {
+    const data = await api.pipelinesControllerFindOne(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 pipeline | [Defaults to `undefined`] |
+
+### Return type
+
+[**Pipeline**](Pipeline.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)
+
+
+## pipelinesControllerUpdate
+
+> Pipeline pipelinesControllerUpdate(updatePipelineDto)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PipelinesApi,
+} from 'ffmpeglab-sdk';
+import type { PipelinesControllerUpdateRequest } 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 PipelinesApi(config);
+
+  const body = {
+    // UpdatePipelineDto
+    updatePipelineDto: ...,
+  } satisfies PipelinesControllerUpdateRequest;
+
+  try {
+    const data = await api.pipelinesControllerUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **updatePipelineDto** | [UpdatePipelineDto](UpdatePipelineDto.md) |  | |
+
+### Return type
+
+[**Pipeline**](Pipeline.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)
+

package/docs/RendersApi.md

@@ -6,7 +6,9 @@ All URIs are relative to *http://localhost*
 |------------- | ------------- | -------------|
 | [**rendersControllerCreate**](RendersApi.md#renderscontrollercreate) | **POST** /renders |  |
 | [**rendersControllerFindAll**](RendersApi.md#renderscontrollerfindall) | **GET** /renders |  |
+| [**rendersControllerFindAllRendersForProject**](RendersApi.md#renderscontrollerfindallrendersforproject) | **GET** /renders/project/{id} |  |
 | [**rendersControllerFindOne**](RendersApi.md#renderscontrollerfindone) | **GET** /renders/{id} |  |
+| [**rendersControllerRenderLogs**](RendersApi.md#renderscontrollerrenderlogs) | **GET** /renders/logs/{id} |  |
 | [**rendersControllerRunRender**](RendersApi.md#renderscontrollerrunrender) | **PUT** /renders/run |  |
 
 
@@ -141,6 +143,75 @@ This endpoint does not need any parameter.
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## rendersControllerFindAllRendersForProject
+
+> Array<RenderResponse> rendersControllerFindAllRendersForProject(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RendersApi,
+} from 'ffmpeglab-sdk';
+import type { RendersControllerFindAllRendersForProjectRequest } 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 RendersControllerFindAllRendersForProjectRequest;
+
+  try {
+    const data = await api.rendersControllerFindAllRendersForProject(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
+
+[**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)
@@ -210,6 +281,81 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## rendersControllerRenderLogs
+
+> LogsResponse rendersControllerRenderLogs(direction, from, id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RendersApi,
+} from 'ffmpeglab-sdk';
+import type { RendersControllerRenderLogsRequest } 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 = {
+    // 'ASC' | 'DESC' | Order by direction
+    direction: direction_example,
+    // string | The date from which to start filtering the logs
+    from: from_example,
+    // string | The ID of the render
+    id: id_example,
+  } satisfies RendersControllerRenderLogsRequest;
+
+  try {
+    const data = await api.rendersControllerRenderLogs(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **direction** | `ASC`, `DESC` | Order by direction | [Defaults to `undefined`] [Enum: ASC, DESC] |
+| **from** | `string` | The date from which to start filtering the logs | [Defaults to `undefined`] |
+| **id** | `string` | The ID of the render | [Defaults to `undefined`] |
+
+### Return type
+
+[**LogsResponse**](LogsResponse.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)

package/docs/UpdatePipelineDto.md

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

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