ffmpeglab-sdk 0.5.7 → 0.6.0

package/docs/ItemsApi.md

@@ -0,0 +1,563 @@
+# ItemsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**itemsControllerCreate**](ItemsApi.md#itemscontrollercreate) | **POST** /item |  |
+| [**itemsControllerDeleteOne**](ItemsApi.md#itemscontrollerdeleteone) | **DELETE** /item/{id} |  |
+| [**itemsControllerFindAllFolders**](ItemsApi.md#itemscontrollerfindallfolders) | **GET** /item/folder |  |
+| [**itemsControllerFindByProject**](ItemsApi.md#itemscontrollerfindbyproject) | **GET** /item/folder/{folderId} |  |
+| [**itemsControllerFindOne**](ItemsApi.md#itemscontrollerfindone) | **GET** /item/{id} |  |
+| [**itemsControllerFindOneByRole**](ItemsApi.md#itemscontrollerfindonebyrole) | **GET** /item/roled/{id} |  |
+| [**itemsControllerUpdate**](ItemsApi.md#itemscontrollerupdate) | **PUT** /item |  |
+| [**itemsControllerUpdateOneByRole**](ItemsApi.md#itemscontrollerupdateonebyrole) | **PUT** /item/roled/{id} |  |
+
+
+
+## itemsControllerCreate
+
+> Item itemsControllerCreate(createItemDto)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ItemsApi,
+} from 'ffmpeglab-sdk';
+import type { ItemsControllerCreateRequest } 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 ItemsApi(config);
+
+  const body = {
+    // CreateItemDto
+    createItemDto: ...,
+  } satisfies ItemsControllerCreateRequest;
+
+  try {
+    const data = await api.itemsControllerCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createItemDto** | [CreateItemDto](CreateItemDto.md) |  | |
+
+### Return type
+
+[**Item**](Item.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)
+
+
+## itemsControllerDeleteOne
+
+> itemsControllerDeleteOne(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ItemsApi,
+} from 'ffmpeglab-sdk';
+import type { ItemsControllerDeleteOneRequest } 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 ItemsApi(config);
+
+  const body = {
+    // string | The ID of the item
+    id: id_example,
+  } satisfies ItemsControllerDeleteOneRequest;
+
+  try {
+    const data = await api.itemsControllerDeleteOne(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 item | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **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)
+
+
+## itemsControllerFindAllFolders
+
+> Array<Item> itemsControllerFindAllFolders()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ItemsApi,
+} from 'ffmpeglab-sdk';
+import type { ItemsControllerFindAllFoldersRequest } 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 ItemsApi(config);
+
+  try {
+    const data = await api.itemsControllerFindAllFolders();
+    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<Item>**](Item.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)
+
+
+## itemsControllerFindByProject
+
+> Array<Item> itemsControllerFindByProject(folderId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ItemsApi,
+} from 'ffmpeglab-sdk';
+import type { ItemsControllerFindByProjectRequest } 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 ItemsApi(config);
+
+  const body = {
+    // string | The folderId for the folder content to be selected
+    folderId: folderId_example,
+  } satisfies ItemsControllerFindByProjectRequest;
+
+  try {
+    const data = await api.itemsControllerFindByProject(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | `string` | The folderId for the folder content to be selected | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<Item>**](Item.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)
+
+
+## itemsControllerFindOne
+
+> Item itemsControllerFindOne(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ItemsApi,
+} from 'ffmpeglab-sdk';
+import type { ItemsControllerFindOneRequest } 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 ItemsApi(config);
+
+  const body = {
+    // string | The ID of the item
+    id: id_example,
+  } satisfies ItemsControllerFindOneRequest;
+
+  try {
+    const data = await api.itemsControllerFindOne(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 item | [Defaults to `undefined`] |
+
+### Return type
+
+[**Item**](Item.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)
+
+
+## itemsControllerFindOneByRole
+
+> Item itemsControllerFindOneByRole(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ItemsApi,
+} from 'ffmpeglab-sdk';
+import type { ItemsControllerFindOneByRoleRequest } 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 ItemsApi(config);
+
+  const body = {
+    // string | The ID of the item
+    id: id_example,
+  } satisfies ItemsControllerFindOneByRoleRequest;
+
+  try {
+    const data = await api.itemsControllerFindOneByRole(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 item | [Defaults to `undefined`] |
+
+### Return type
+
+[**Item**](Item.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)
+
+
+## itemsControllerUpdate
+
+> Item itemsControllerUpdate(updateItemDto)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ItemsApi,
+} from 'ffmpeglab-sdk';
+import type { ItemsControllerUpdateRequest } 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 ItemsApi(config);
+
+  const body = {
+    // UpdateItemDto
+    updateItemDto: ...,
+  } satisfies ItemsControllerUpdateRequest;
+
+  try {
+    const data = await api.itemsControllerUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **updateItemDto** | [UpdateItemDto](UpdateItemDto.md) |  | |
+
+### Return type
+
+[**Item**](Item.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)
+
+
+## itemsControllerUpdateOneByRole
+
+> Item itemsControllerUpdateOneByRole(id, updateItemDto)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ItemsApi,
+} from 'ffmpeglab-sdk';
+import type { ItemsControllerUpdateOneByRoleRequest } 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 ItemsApi(config);
+
+  const body = {
+    // string | The ID of the item
+    id: id_example,
+    // UpdateItemDto
+    updateItemDto: ...,
+  } satisfies ItemsControllerUpdateOneByRoleRequest;
+
+  try {
+    const data = await api.itemsControllerUpdateOneByRole(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 item | [Defaults to `undefined`] |
+| **updateItemDto** | [UpdateItemDto](UpdateItemDto.md) |  | |
+
+### Return type
+
+[**Item**](Item.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/PublicApi.md

@@ -4,10 +4,142 @@ All URIs are relative to *http://localhost*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**publicControllerGetPublicFolder**](PublicApi.md#publiccontrollergetpublicfolder) | **GET** /public/folder/{id} |  |
+| [**publicControllerGetPublicItem**](PublicApi.md#publiccontrollergetpublicitem) | **GET** /public/item/{id} |  |
 | [**publicControllerGetPublicRender**](PublicApi.md#publiccontrollergetpublicrender) | **GET** /public/renders/{id} |  |
 
 
 
+## publicControllerGetPublicFolder
+
+> RenderResponse publicControllerGetPublicFolder(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PublicApi,
+} from 'ffmpeglab-sdk';
+import type { PublicControllerGetPublicFolderRequest } 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 PublicControllerGetPublicFolderRequest;
+
+  try {
+    const data = await api.publicControllerGetPublicFolder(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)
+
+
+## publicControllerGetPublicItem
+
+> RenderResponse publicControllerGetPublicItem(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PublicApi,
+} from 'ffmpeglab-sdk';
+import type { PublicControllerGetPublicItemRequest } 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 PublicControllerGetPublicItemRequest;
+
+  try {
+    const data = await api.publicControllerGetPublicItem(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)
+
+
 ## publicControllerGetPublicRender
 
 > RenderResponse publicControllerGetPublicRender(id)