ffmpeglab-sdk 0.4.19 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,202 @@
1
+ # ApiKeyApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**apiKeyControllerCreate**](ApiKeyApi.md#apikeycontrollercreate) | **POST** /apikey | |
8
+ | [**apiKeyControllerDeleteOne**](ApiKeyApi.md#apikeycontrollerdeleteone) | **DELETE** /apikey/{id} | |
9
+ | [**apiKeyControllerFindAll**](ApiKeyApi.md#apikeycontrollerfindall) | **GET** /apikey | |
10
+
11
+
12
+
13
+ ## apiKeyControllerCreate
14
+
15
+ > object apiKeyControllerCreate()
16
+
17
+
18
+
19
+ ### Example
20
+
21
+ ```ts
22
+ import {
23
+ Configuration,
24
+ ApiKeyApi,
25
+ } from 'ffmpeglab-sdk';
26
+ import type { ApiKeyControllerCreateRequest } from 'ffmpeglab-sdk';
27
+
28
+ async function example() {
29
+ console.log("🚀 Testing ffmpeglab-sdk SDK...");
30
+ const config = new Configuration({
31
+ // Configure HTTP bearer authorization: bearer
32
+ accessToken: "YOUR BEARER TOKEN",
33
+ });
34
+ const api = new ApiKeyApi(config);
35
+
36
+ try {
37
+ const data = await api.apiKeyControllerCreate();
38
+ console.log(data);
39
+ } catch (error) {
40
+ console.error(error);
41
+ }
42
+ }
43
+
44
+ // Run the test
45
+ example().catch(console.error);
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+ This endpoint does not need any parameter.
51
+
52
+ ### Return type
53
+
54
+ **object**
55
+
56
+ ### Authorization
57
+
58
+ [bearer](../README.md#bearer)
59
+
60
+ ### HTTP request headers
61
+
62
+ - **Content-Type**: Not defined
63
+ - **Accept**: `application/json`
64
+
65
+
66
+ ### HTTP response details
67
+ | Status code | Description | Response headers |
68
+ |-------------|-------------|------------------|
69
+ | **0** | | - |
70
+
71
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
72
+
73
+
74
+ ## apiKeyControllerDeleteOne
75
+
76
+ > apiKeyControllerDeleteOne(id)
77
+
78
+
79
+
80
+ ### Example
81
+
82
+ ```ts
83
+ import {
84
+ Configuration,
85
+ ApiKeyApi,
86
+ } from 'ffmpeglab-sdk';
87
+ import type { ApiKeyControllerDeleteOneRequest } from 'ffmpeglab-sdk';
88
+
89
+ async function example() {
90
+ console.log("🚀 Testing ffmpeglab-sdk SDK...");
91
+ const config = new Configuration({
92
+ // Configure HTTP bearer authorization: bearer
93
+ accessToken: "YOUR BEARER TOKEN",
94
+ });
95
+ const api = new ApiKeyApi(config);
96
+
97
+ const body = {
98
+ // string | The ID of the pipeline
99
+ id: id_example,
100
+ } satisfies ApiKeyControllerDeleteOneRequest;
101
+
102
+ try {
103
+ const data = await api.apiKeyControllerDeleteOne(body);
104
+ console.log(data);
105
+ } catch (error) {
106
+ console.error(error);
107
+ }
108
+ }
109
+
110
+ // Run the test
111
+ example().catch(console.error);
112
+ ```
113
+
114
+ ### Parameters
115
+
116
+
117
+ | Name | Type | Description | Notes |
118
+ |------------- | ------------- | ------------- | -------------|
119
+ | **id** | `string` | The ID of the pipeline | [Defaults to `undefined`] |
120
+
121
+ ### Return type
122
+
123
+ `void` (Empty response body)
124
+
125
+ ### Authorization
126
+
127
+ [bearer](../README.md#bearer)
128
+
129
+ ### HTTP request headers
130
+
131
+ - **Content-Type**: Not defined
132
+ - **Accept**: Not defined
133
+
134
+
135
+ ### HTTP response details
136
+ | Status code | Description | Response headers |
137
+ |-------------|-------------|------------------|
138
+ | **200** | | - |
139
+
140
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
141
+
142
+
143
+ ## apiKeyControllerFindAll
144
+
145
+ > Array<object> apiKeyControllerFindAll()
146
+
147
+
148
+
149
+ ### Example
150
+
151
+ ```ts
152
+ import {
153
+ Configuration,
154
+ ApiKeyApi,
155
+ } from 'ffmpeglab-sdk';
156
+ import type { ApiKeyControllerFindAllRequest } from 'ffmpeglab-sdk';
157
+
158
+ async function example() {
159
+ console.log("🚀 Testing ffmpeglab-sdk SDK...");
160
+ const config = new Configuration({
161
+ // Configure HTTP bearer authorization: bearer
162
+ accessToken: "YOUR BEARER TOKEN",
163
+ });
164
+ const api = new ApiKeyApi(config);
165
+
166
+ try {
167
+ const data = await api.apiKeyControllerFindAll();
168
+ console.log(data);
169
+ } catch (error) {
170
+ console.error(error);
171
+ }
172
+ }
173
+
174
+ // Run the test
175
+ example().catch(console.error);
176
+ ```
177
+
178
+ ### Parameters
179
+
180
+ This endpoint does not need any parameter.
181
+
182
+ ### Return type
183
+
184
+ **Array<object>**
185
+
186
+ ### Authorization
187
+
188
+ [bearer](../README.md#bearer)
189
+
190
+ ### HTTP request headers
191
+
192
+ - **Content-Type**: Not defined
193
+ - **Accept**: `application/json`
194
+
195
+
196
+ ### HTTP response details
197
+ | Status code | Description | Response headers |
198
+ |-------------|-------------|------------------|
199
+ | **0** | | - |
200
+
201
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
202
+
@@ -10,6 +10,7 @@ Name | Type
10
10
  `downsql` | string
11
11
  `upsql` | string
12
12
  `yml` | string
13
+ `project` | string
13
14
 
14
15
  ## Example
15
16
 
@@ -22,6 +23,7 @@ const example = {
22
23
  "downsql": null,
23
24
  "upsql": null,
24
25
  "yml": null,
26
+ "project": null,
25
27
  } satisfies CreatePipelineDto
26
28
 
27
29
  console.log(example)
package/docs/Pipeline.md CHANGED
@@ -13,6 +13,7 @@ Name | Type
13
13
  `downsql` | string
14
14
  `upsql` | string
15
15
  `yml` | string
16
+ `project` | string
16
17
  `date` | Date
17
18
  `version` | number
18
19
 
@@ -30,6 +31,7 @@ const example = {
30
31
  "downsql": null,
31
32
  "upsql": null,
32
33
  "yml": null,
34
+ "project": null,
33
35
  "date": null,
34
36
  "version": null,
35
37
  } satisfies Pipeline
@@ -5,7 +5,9 @@ All URIs are relative to *http://localhost*
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
7
  | [**pipelinesControllerCreate**](PipelinesApi.md#pipelinescontrollercreate) | **POST** /pipeline | |
8
+ | [**pipelinesControllerDeleteOne**](PipelinesApi.md#pipelinescontrollerdeleteone) | **DELETE** /pipeline/{id} | |
8
9
  | [**pipelinesControllerFindAll**](PipelinesApi.md#pipelinescontrollerfindall) | **GET** /pipeline | |
10
+ | [**pipelinesControllerFindByProject**](PipelinesApi.md#pipelinescontrollerfindbyproject) | **GET** /pipeline/project/{projectId} | |
9
11
  | [**pipelinesControllerFindOne**](PipelinesApi.md#pipelinescontrollerfindone) | **GET** /pipeline/{id} | |
10
12
  | [**pipelinesControllerTranspile**](PipelinesApi.md#pipelinescontrollertranspile) | **POST** /pipeline/transpile | |
11
13
  | [**pipelinesControllerUpdate**](PipelinesApi.md#pipelinescontrollerupdate) | **PUT** /pipeline | |
@@ -81,6 +83,75 @@ example().catch(console.error);
81
83
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
82
84
 
83
85
 
86
+ ## pipelinesControllerDeleteOne
87
+
88
+ > pipelinesControllerDeleteOne(id)
89
+
90
+
91
+
92
+ ### Example
93
+
94
+ ```ts
95
+ import {
96
+ Configuration,
97
+ PipelinesApi,
98
+ } from 'ffmpeglab-sdk';
99
+ import type { PipelinesControllerDeleteOneRequest } from 'ffmpeglab-sdk';
100
+
101
+ async function example() {
102
+ console.log("🚀 Testing ffmpeglab-sdk SDK...");
103
+ const config = new Configuration({
104
+ // Configure HTTP bearer authorization: bearer
105
+ accessToken: "YOUR BEARER TOKEN",
106
+ });
107
+ const api = new PipelinesApi(config);
108
+
109
+ const body = {
110
+ // string | The ID of the pipeline
111
+ id: id_example,
112
+ } satisfies PipelinesControllerDeleteOneRequest;
113
+
114
+ try {
115
+ const data = await api.pipelinesControllerDeleteOne(body);
116
+ console.log(data);
117
+ } catch (error) {
118
+ console.error(error);
119
+ }
120
+ }
121
+
122
+ // Run the test
123
+ example().catch(console.error);
124
+ ```
125
+
126
+ ### Parameters
127
+
128
+
129
+ | Name | Type | Description | Notes |
130
+ |------------- | ------------- | ------------- | -------------|
131
+ | **id** | `string` | The ID of the pipeline | [Defaults to `undefined`] |
132
+
133
+ ### Return type
134
+
135
+ `void` (Empty response body)
136
+
137
+ ### Authorization
138
+
139
+ [bearer](../README.md#bearer)
140
+
141
+ ### HTTP request headers
142
+
143
+ - **Content-Type**: Not defined
144
+ - **Accept**: Not defined
145
+
146
+
147
+ ### HTTP response details
148
+ | Status code | Description | Response headers |
149
+ |-------------|-------------|------------------|
150
+ | **200** | | - |
151
+
152
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
153
+
154
+
84
155
  ## pipelinesControllerFindAll
85
156
 
86
157
  > Array&lt;Pipeline&gt; pipelinesControllerFindAll()
@@ -142,6 +213,75 @@ This endpoint does not need any parameter.
142
213
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
143
214
 
144
215
 
216
+ ## pipelinesControllerFindByProject
217
+
218
+ > Array&lt;Pipeline&gt; pipelinesControllerFindByProject(projectId)
219
+
220
+
221
+
222
+ ### Example
223
+
224
+ ```ts
225
+ import {
226
+ Configuration,
227
+ PipelinesApi,
228
+ } from 'ffmpeglab-sdk';
229
+ import type { PipelinesControllerFindByProjectRequest } from 'ffmpeglab-sdk';
230
+
231
+ async function example() {
232
+ console.log("🚀 Testing ffmpeglab-sdk SDK...");
233
+ const config = new Configuration({
234
+ // Configure HTTP bearer authorization: bearer
235
+ accessToken: "YOUR BEARER TOKEN",
236
+ });
237
+ const api = new PipelinesApi(config);
238
+
239
+ const body = {
240
+ // string | The projectId for the pipelines to be selected
241
+ projectId: projectId_example,
242
+ } satisfies PipelinesControllerFindByProjectRequest;
243
+
244
+ try {
245
+ const data = await api.pipelinesControllerFindByProject(body);
246
+ console.log(data);
247
+ } catch (error) {
248
+ console.error(error);
249
+ }
250
+ }
251
+
252
+ // Run the test
253
+ example().catch(console.error);
254
+ ```
255
+
256
+ ### Parameters
257
+
258
+
259
+ | Name | Type | Description | Notes |
260
+ |------------- | ------------- | ------------- | -------------|
261
+ | **projectId** | `string` | The projectId for the pipelines to be selected | [Defaults to `undefined`] |
262
+
263
+ ### Return type
264
+
265
+ [**Array&lt;Pipeline&gt;**](Pipeline.md)
266
+
267
+ ### Authorization
268
+
269
+ [bearer](../README.md#bearer)
270
+
271
+ ### HTTP request headers
272
+
273
+ - **Content-Type**: Not defined
274
+ - **Accept**: `application/json`
275
+
276
+
277
+ ### HTTP response details
278
+ | Status code | Description | Response headers |
279
+ |-------------|-------------|------------------|
280
+ | **0** | | - |
281
+
282
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
283
+
284
+
145
285
  ## pipelinesControllerFindOne
146
286
 
147
287
  > Pipeline pipelinesControllerFindOne(id)
package/package.json CHANGED
@@ -17,5 +17,5 @@
17
17
  "devDependencies": {
18
18
  "typescript": "^4.0 || ^5.0"
19
19
  },
20
- "version": "0.4.19"
20
+ "version": "0.5.0"
21
21
  }
@@ -0,0 +1,230 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * FFmpeglab
5
+ * FFmpeglab API
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import * as runtime from '../runtime';
16
+
17
+ export interface ApiKeyControllerDeleteOneRequest {
18
+ id: string;
19
+ }
20
+
21
+ /**
22
+ * ApiKeyApi - interface
23
+ *
24
+ * @export
25
+ * @interface ApiKeyApiInterface
26
+ */
27
+ export interface ApiKeyApiInterface {
28
+ /**
29
+ * Creates request options for apiKeyControllerCreate without sending the request
30
+ * @throws {RequiredError}
31
+ * @memberof ApiKeyApiInterface
32
+ */
33
+ apiKeyControllerCreateRequestOpts(): Promise<runtime.RequestOpts>;
34
+
35
+ /**
36
+ *
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ * @memberof ApiKeyApiInterface
40
+ */
41
+ apiKeyControllerCreateRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
42
+
43
+ /**
44
+ */
45
+ apiKeyControllerCreate(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
46
+
47
+ /**
48
+ * Creates request options for apiKeyControllerDeleteOne without sending the request
49
+ * @param {string} id The ID of the pipeline
50
+ * @throws {RequiredError}
51
+ * @memberof ApiKeyApiInterface
52
+ */
53
+ apiKeyControllerDeleteOneRequestOpts(requestParameters: ApiKeyControllerDeleteOneRequest): Promise<runtime.RequestOpts>;
54
+
55
+ /**
56
+ *
57
+ * @param {string} id The ID of the pipeline
58
+ * @param {*} [options] Override http request option.
59
+ * @throws {RequiredError}
60
+ * @memberof ApiKeyApiInterface
61
+ */
62
+ apiKeyControllerDeleteOneRaw(requestParameters: ApiKeyControllerDeleteOneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
63
+
64
+ /**
65
+ */
66
+ apiKeyControllerDeleteOne(requestParameters: ApiKeyControllerDeleteOneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
67
+
68
+ /**
69
+ * Creates request options for apiKeyControllerFindAll without sending the request
70
+ * @throws {RequiredError}
71
+ * @memberof ApiKeyApiInterface
72
+ */
73
+ apiKeyControllerFindAllRequestOpts(): Promise<runtime.RequestOpts>;
74
+
75
+ /**
76
+ *
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ * @memberof ApiKeyApiInterface
80
+ */
81
+ apiKeyControllerFindAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<object>>>;
82
+
83
+ /**
84
+ */
85
+ apiKeyControllerFindAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<object>>;
86
+
87
+ }
88
+
89
+ /**
90
+ *
91
+ */
92
+ export class ApiKeyApi extends runtime.BaseAPI implements ApiKeyApiInterface {
93
+
94
+ /**
95
+ * Creates request options for apiKeyControllerCreate without sending the request
96
+ */
97
+ async apiKeyControllerCreateRequestOpts(): Promise<runtime.RequestOpts> {
98
+ const queryParameters: any = {};
99
+
100
+ const headerParameters: runtime.HTTPHeaders = {};
101
+
102
+ if (this.configuration && this.configuration.accessToken) {
103
+ const token = this.configuration.accessToken;
104
+ const tokenString = await token("bearer", []);
105
+
106
+ if (tokenString) {
107
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
108
+ }
109
+ }
110
+
111
+ let urlPath = `/apikey`;
112
+
113
+ return {
114
+ path: urlPath,
115
+ method: 'POST',
116
+ headers: headerParameters,
117
+ query: queryParameters,
118
+ };
119
+ }
120
+
121
+ /**
122
+ */
123
+ async apiKeyControllerCreateRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
124
+ const requestOptions = await this.apiKeyControllerCreateRequestOpts();
125
+ const response = await this.request(requestOptions, initOverrides);
126
+
127
+ return new runtime.JSONApiResponse<any>(response);
128
+ }
129
+
130
+ /**
131
+ */
132
+ async apiKeyControllerCreate(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
133
+ const response = await this.apiKeyControllerCreateRaw(initOverrides);
134
+ return await response.value();
135
+ }
136
+
137
+ /**
138
+ * Creates request options for apiKeyControllerDeleteOne without sending the request
139
+ */
140
+ async apiKeyControllerDeleteOneRequestOpts(requestParameters: ApiKeyControllerDeleteOneRequest): Promise<runtime.RequestOpts> {
141
+ if (requestParameters['id'] == null) {
142
+ throw new runtime.RequiredError(
143
+ 'id',
144
+ 'Required parameter "id" was null or undefined when calling apiKeyControllerDeleteOne().'
145
+ );
146
+ }
147
+
148
+ const queryParameters: any = {};
149
+
150
+ const headerParameters: runtime.HTTPHeaders = {};
151
+
152
+ if (this.configuration && this.configuration.accessToken) {
153
+ const token = this.configuration.accessToken;
154
+ const tokenString = await token("bearer", []);
155
+
156
+ if (tokenString) {
157
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
158
+ }
159
+ }
160
+
161
+ let urlPath = `/apikey/{id}`;
162
+ urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
163
+
164
+ return {
165
+ path: urlPath,
166
+ method: 'DELETE',
167
+ headers: headerParameters,
168
+ query: queryParameters,
169
+ };
170
+ }
171
+
172
+ /**
173
+ */
174
+ async apiKeyControllerDeleteOneRaw(requestParameters: ApiKeyControllerDeleteOneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
175
+ const requestOptions = await this.apiKeyControllerDeleteOneRequestOpts(requestParameters);
176
+ const response = await this.request(requestOptions, initOverrides);
177
+
178
+ return new runtime.VoidApiResponse(response);
179
+ }
180
+
181
+ /**
182
+ */
183
+ async apiKeyControllerDeleteOne(requestParameters: ApiKeyControllerDeleteOneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
184
+ await this.apiKeyControllerDeleteOneRaw(requestParameters, initOverrides);
185
+ }
186
+
187
+ /**
188
+ * Creates request options for apiKeyControllerFindAll without sending the request
189
+ */
190
+ async apiKeyControllerFindAllRequestOpts(): Promise<runtime.RequestOpts> {
191
+ const queryParameters: any = {};
192
+
193
+ const headerParameters: runtime.HTTPHeaders = {};
194
+
195
+ if (this.configuration && this.configuration.accessToken) {
196
+ const token = this.configuration.accessToken;
197
+ const tokenString = await token("bearer", []);
198
+
199
+ if (tokenString) {
200
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
201
+ }
202
+ }
203
+
204
+ let urlPath = `/apikey`;
205
+
206
+ return {
207
+ path: urlPath,
208
+ method: 'GET',
209
+ headers: headerParameters,
210
+ query: queryParameters,
211
+ };
212
+ }
213
+
214
+ /**
215
+ */
216
+ async apiKeyControllerFindAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<object>>> {
217
+ const requestOptions = await this.apiKeyControllerFindAllRequestOpts();
218
+ const response = await this.request(requestOptions, initOverrides);
219
+
220
+ return new runtime.JSONApiResponse<any>(response);
221
+ }
222
+
223
+ /**
224
+ */
225
+ async apiKeyControllerFindAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<object>> {
226
+ const response = await this.apiKeyControllerFindAllRaw(initOverrides);
227
+ return await response.value();
228
+ }
229
+
230
+ }