ffmpeglab-sdk 0.5.7 → 0.6.0

package/docs/Role.md

@@ -0,0 +1,50 @@
+
+# Role
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`title` | string
+`item` | string
+`render` | string
+`owner` | string
+`userId` | string
+`permission` | string
+`created` | Date
+`updated` | Date
+
+## Example
+
+```typescript
+import type { Role } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "title": null,
+  "item": null,
+  "render": null,
+  "owner": null,
+  "userId": null,
+  "permission": null,
+  "created": null,
+  "updated": null,
+} satisfies Role
+
+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 Role
+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/RolesApi.md

@@ -0,0 +1,420 @@
+# RolesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**rolesControllerCreate**](RolesApi.md#rolescontrollercreate) | **POST** /role |  |
+| [**rolesControllerDeleteOne**](RolesApi.md#rolescontrollerdeleteone) | **DELETE** /role/{id} |  |
+| [**rolesControllerFindAllAssignedRoles**](RolesApi.md#rolescontrollerfindallassignedroles) | **GET** /role |  |
+| [**rolesControllerFindByProject**](RolesApi.md#rolescontrollerfindbyproject) | **GET** /role/folder/{folderId} |  |
+| [**rolesControllerFindOne**](RolesApi.md#rolescontrollerfindone) | **GET** /role/{id} |  |
+| [**rolesControllerUpdate**](RolesApi.md#rolescontrollerupdate) | **PUT** /role |  |
+
+
+
+## rolesControllerCreate
+
+> Role rolesControllerCreate(createRoleDto)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from 'ffmpeglab-sdk';
+import type { RolesControllerCreateRequest } 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 RolesApi(config);
+
+  const body = {
+    // CreateRoleDto
+    createRoleDto: ...,
+  } satisfies RolesControllerCreateRequest;
+
+  try {
+    const data = await api.rolesControllerCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createRoleDto** | [CreateRoleDto](CreateRoleDto.md) |  | |
+
+### Return type
+
+[**Role**](Role.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)
+
+
+## rolesControllerDeleteOne
+
+> rolesControllerDeleteOne(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from 'ffmpeglab-sdk';
+import type { RolesControllerDeleteOneRequest } 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 RolesApi(config);
+
+  const body = {
+    // string | The ID of the pipeline
+    id: id_example,
+  } satisfies RolesControllerDeleteOneRequest;
+
+  try {
+    const data = await api.rolesControllerDeleteOne(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
+
+`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)
+
+
+## rolesControllerFindAllAssignedRoles
+
+> Array<Role> rolesControllerFindAllAssignedRoles()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from 'ffmpeglab-sdk';
+import type { RolesControllerFindAllAssignedRolesRequest } 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 RolesApi(config);
+
+  try {
+    const data = await api.rolesControllerFindAllAssignedRoles();
+    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<Role>**](Role.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)
+
+
+## rolesControllerFindByProject
+
+> Array<Role> rolesControllerFindByProject(folderId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from 'ffmpeglab-sdk';
+import type { RolesControllerFindByProjectRequest } 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 RolesApi(config);
+
+  const body = {
+    // string | The folderId for the folder content to be selected
+    folderId: folderId_example,
+  } satisfies RolesControllerFindByProjectRequest;
+
+  try {
+    const data = await api.rolesControllerFindByProject(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<Role>**](Role.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)
+
+
+## rolesControllerFindOne
+
+> Role rolesControllerFindOne(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from 'ffmpeglab-sdk';
+import type { RolesControllerFindOneRequest } 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 RolesApi(config);
+
+  const body = {
+    // string | The ID of the pipeline
+    id: id_example,
+  } satisfies RolesControllerFindOneRequest;
+
+  try {
+    const data = await api.rolesControllerFindOne(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
+
+[**Role**](Role.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)
+
+
+## rolesControllerUpdate
+
+> Role rolesControllerUpdate(updateRoleDto)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RolesApi,
+} from 'ffmpeglab-sdk';
+import type { RolesControllerUpdateRequest } 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 RolesApi(config);
+
+  const body = {
+    // UpdateRoleDto
+    updateRoleDto: ...,
+  } satisfies RolesControllerUpdateRequest;
+
+  try {
+    const data = await api.rolesControllerUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **updateRoleDto** | [UpdateRoleDto](UpdateRoleDto.md) |  | |
+
+### Return type
+
+[**Role**](Role.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/UpdateItemDto.md

@@ -0,0 +1,46 @@
+
+# UpdateItemDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`title` | string
+`folder` | string
+`isFolder` | boolean
+`_public` | boolean
+`order` | number
+`item` | object
+
+## Example
+
+```typescript
+import type { UpdateItemDto } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "title": null,
+  "folder": null,
+  "isFolder": null,
+  "_public": null,
+  "order": null,
+  "item": null,
+} satisfies UpdateItemDto
+
+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 UpdateItemDto
+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/UpdateRoleDto.md

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