@teemill/file-processor 0.3.1 → 0.3.3
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.
- package/README.md +47 -2
- package/api.ts +24 -24
- package/base.ts +3 -3
- package/common.ts +3 -3
- package/configuration.ts +9 -4
- package/dist/api.d.ts +25 -25
- package/dist/api.js +6 -6
- package/dist/base.d.ts +3 -3
- package/dist/base.js +3 -3
- package/dist/common.d.ts +4 -4
- package/dist/common.js +3 -3
- package/dist/configuration.d.ts +3 -3
- package/dist/configuration.js +5 -4
- package/dist/esm/api.d.ts +25 -25
- package/dist/esm/api.js +6 -6
- package/dist/esm/base.d.ts +3 -3
- package/dist/esm/base.js +3 -3
- package/dist/esm/common.d.ts +4 -4
- package/dist/esm/common.js +3 -3
- package/dist/esm/configuration.d.ts +3 -3
- package/dist/esm/configuration.js +5 -4
- package/dist/esm/index.d.ts +3 -3
- package/dist/esm/index.js +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- package/docs/ApiError.md +22 -0
- package/docs/CreateJobRequest.md +24 -0
- package/docs/GetHealth200Response.md +20 -0
- package/docs/HealthApi.md +53 -0
- package/docs/InlineObject.md +22 -0
- package/docs/Job.md +38 -0
- package/docs/JobInput.md +22 -0
- package/docs/JobOutput.md +22 -0
- package/docs/ProcessorApi.md +249 -0
- package/index.ts +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/file-processor@0.3.
|
|
1
|
+
## @teemill/file-processor@0.3.3
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/file-processor@0.3.
|
|
39
|
+
npm install @teemill/file-processor@0.3.3 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -44,3 +44,48 @@ _unPublished (not recommended):_
|
|
|
44
44
|
```
|
|
45
45
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
46
46
|
```
|
|
47
|
+
|
|
48
|
+
### Documentation for API Endpoints
|
|
49
|
+
|
|
50
|
+
All URIs are relative to *https://api.localhost:8080*
|
|
51
|
+
|
|
52
|
+
Class | Method | HTTP request | Description
|
|
53
|
+
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*HealthApi* | [**getHealth**](docs/HealthApi.md#gethealth) | **GET** /healthz | Get health
|
|
55
|
+
*ProcessorApi* | [**createJob**](docs/ProcessorApi.md#createjob) | **POST** /jobs | Create job
|
|
56
|
+
*ProcessorApi* | [**deleteJob**](docs/ProcessorApi.md#deletejob) | **DELETE** /jobs/{job} | Delete job
|
|
57
|
+
*ProcessorApi* | [**getJob**](docs/ProcessorApi.md#getjob) | **GET** /jobs/{job} | Get job
|
|
58
|
+
*ProcessorApi* | [**listJobs**](docs/ProcessorApi.md#listjobs) | **GET** /jobs | List jobs
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### Documentation For Models
|
|
62
|
+
|
|
63
|
+
- [ApiError](docs/ApiError.md)
|
|
64
|
+
- [CreateJobRequest](docs/CreateJobRequest.md)
|
|
65
|
+
- [GetHealth200Response](docs/GetHealth200Response.md)
|
|
66
|
+
- [InlineObject](docs/InlineObject.md)
|
|
67
|
+
- [Job](docs/Job.md)
|
|
68
|
+
- [JobInput](docs/JobInput.md)
|
|
69
|
+
- [JobOutput](docs/JobOutput.md)
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<a id="documentation-for-authorization"></a>
|
|
73
|
+
## Documentation For Authorization
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
Authentication schemes defined for the API:
|
|
77
|
+
<a id="api-key"></a>
|
|
78
|
+
### api-key
|
|
79
|
+
|
|
80
|
+
- **Type**: API key
|
|
81
|
+
- **API key parameter name**: Authorization
|
|
82
|
+
- **Location**: HTTP header
|
|
83
|
+
|
|
84
|
+
<a id="session-oauth"></a>
|
|
85
|
+
### session-oauth
|
|
86
|
+
|
|
87
|
+
- **Type**: OAuth
|
|
88
|
+
- **Flow**: password
|
|
89
|
+
- **Authorization URL**:
|
|
90
|
+
- **Scopes**: N/A
|
|
91
|
+
|
package/api.ts
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.
|
|
8
|
-
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
8
|
+
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
@@ -80,6 +80,25 @@ export interface GetHealth200Response {
|
|
|
80
80
|
*/
|
|
81
81
|
'status'?: string;
|
|
82
82
|
}
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @export
|
|
86
|
+
* @interface InlineObject
|
|
87
|
+
*/
|
|
88
|
+
export interface InlineObject {
|
|
89
|
+
/**
|
|
90
|
+
*
|
|
91
|
+
* @type {Array<Job>}
|
|
92
|
+
* @memberof InlineObject
|
|
93
|
+
*/
|
|
94
|
+
'jobs': Array<Job>;
|
|
95
|
+
/**
|
|
96
|
+
*
|
|
97
|
+
* @type {number}
|
|
98
|
+
* @memberof InlineObject
|
|
99
|
+
*/
|
|
100
|
+
'nextPageToken': number;
|
|
101
|
+
}
|
|
83
102
|
/**
|
|
84
103
|
*
|
|
85
104
|
* @export
|
|
@@ -185,25 +204,6 @@ export interface JobOutput {
|
|
|
185
204
|
*/
|
|
186
205
|
'thumbnail': string;
|
|
187
206
|
}
|
|
188
|
-
/**
|
|
189
|
-
*
|
|
190
|
-
* @export
|
|
191
|
-
* @interface ListJobs200Response
|
|
192
|
-
*/
|
|
193
|
-
export interface ListJobs200Response {
|
|
194
|
-
/**
|
|
195
|
-
*
|
|
196
|
-
* @type {Array<Job>}
|
|
197
|
-
* @memberof ListJobs200Response
|
|
198
|
-
*/
|
|
199
|
-
'jobs': Array<Job>;
|
|
200
|
-
/**
|
|
201
|
-
*
|
|
202
|
-
* @type {number}
|
|
203
|
-
* @memberof ListJobs200Response
|
|
204
|
-
*/
|
|
205
|
-
'nextPageToken': number;
|
|
206
|
-
}
|
|
207
207
|
|
|
208
208
|
/**
|
|
209
209
|
* HealthApi - axios parameter creator
|
|
@@ -580,7 +580,7 @@ export const ProcessorApiFp = function(configuration?: Configuration) {
|
|
|
580
580
|
* @param {*} [options] Override http request option.
|
|
581
581
|
* @throws {RequiredError}
|
|
582
582
|
*/
|
|
583
|
-
async listJobs(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
583
|
+
async listJobs(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>> {
|
|
584
584
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listJobs(project, pageToken, pageSize, options);
|
|
585
585
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
586
586
|
const localVarOperationServerBasePath = operationServerMap['ProcessorApi.listJobs']?.[localVarOperationServerIndex]?.url;
|
|
@@ -633,7 +633,7 @@ export const ProcessorApiFactory = function (configuration?: Configuration, base
|
|
|
633
633
|
* @param {*} [options] Override http request option.
|
|
634
634
|
* @throws {RequiredError}
|
|
635
635
|
*/
|
|
636
|
-
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
636
|
+
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject> {
|
|
637
637
|
return localVarFp.listJobs(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
638
638
|
},
|
|
639
639
|
};
|
package/base.ts
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.
|
|
8
|
-
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
8
|
+
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
package/common.ts
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.
|
|
8
|
-
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
8
|
+
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
package/configuration.ts
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.
|
|
8
|
-
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
8
|
+
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
@@ -89,7 +89,12 @@ export class Configuration {
|
|
|
89
89
|
this.accessToken = param.accessToken;
|
|
90
90
|
this.basePath = param.basePath;
|
|
91
91
|
this.serverIndex = param.serverIndex;
|
|
92
|
-
this.baseOptions =
|
|
92
|
+
this.baseOptions = {
|
|
93
|
+
...param.baseOptions,
|
|
94
|
+
headers: {
|
|
95
|
+
...param.baseOptions?.headers,
|
|
96
|
+
},
|
|
97
|
+
};
|
|
93
98
|
this.formDataCtor = param.formDataCtor;
|
|
94
99
|
}
|
|
95
100
|
|
package/dist/api.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -70,6 +70,25 @@ export interface GetHealth200Response {
|
|
|
70
70
|
*/
|
|
71
71
|
'status'?: string;
|
|
72
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
*
|
|
75
|
+
* @export
|
|
76
|
+
* @interface InlineObject
|
|
77
|
+
*/
|
|
78
|
+
export interface InlineObject {
|
|
79
|
+
/**
|
|
80
|
+
*
|
|
81
|
+
* @type {Array<Job>}
|
|
82
|
+
* @memberof InlineObject
|
|
83
|
+
*/
|
|
84
|
+
'jobs': Array<Job>;
|
|
85
|
+
/**
|
|
86
|
+
*
|
|
87
|
+
* @type {number}
|
|
88
|
+
* @memberof InlineObject
|
|
89
|
+
*/
|
|
90
|
+
'nextPageToken': number;
|
|
91
|
+
}
|
|
73
92
|
/**
|
|
74
93
|
*
|
|
75
94
|
* @export
|
|
@@ -175,25 +194,6 @@ export interface JobOutput {
|
|
|
175
194
|
*/
|
|
176
195
|
'thumbnail': string;
|
|
177
196
|
}
|
|
178
|
-
/**
|
|
179
|
-
*
|
|
180
|
-
* @export
|
|
181
|
-
* @interface ListJobs200Response
|
|
182
|
-
*/
|
|
183
|
-
export interface ListJobs200Response {
|
|
184
|
-
/**
|
|
185
|
-
*
|
|
186
|
-
* @type {Array<Job>}
|
|
187
|
-
* @memberof ListJobs200Response
|
|
188
|
-
*/
|
|
189
|
-
'jobs': Array<Job>;
|
|
190
|
-
/**
|
|
191
|
-
*
|
|
192
|
-
* @type {number}
|
|
193
|
-
* @memberof ListJobs200Response
|
|
194
|
-
*/
|
|
195
|
-
'nextPageToken': number;
|
|
196
|
-
}
|
|
197
197
|
/**
|
|
198
198
|
* HealthApi - axios parameter creator
|
|
199
199
|
* @export
|
|
@@ -333,7 +333,7 @@ export declare const ProcessorApiFp: (configuration?: Configuration) => {
|
|
|
333
333
|
* @param {*} [options] Override http request option.
|
|
334
334
|
* @throws {RequiredError}
|
|
335
335
|
*/
|
|
336
|
-
listJobs(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
336
|
+
listJobs(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
|
|
337
337
|
};
|
|
338
338
|
/**
|
|
339
339
|
* ProcessorApi - factory interface
|
|
@@ -371,7 +371,7 @@ export declare const ProcessorApiFactory: (configuration?: Configuration, basePa
|
|
|
371
371
|
* @param {*} [options] Override http request option.
|
|
372
372
|
* @throws {RequiredError}
|
|
373
373
|
*/
|
|
374
|
-
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
374
|
+
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
|
|
375
375
|
};
|
|
376
376
|
/**
|
|
377
377
|
* Request parameters for createJob operation in ProcessorApi.
|
|
@@ -497,5 +497,5 @@ export declare class ProcessorApi extends BaseAPI {
|
|
|
497
497
|
* @throws {RequiredError}
|
|
498
498
|
* @memberof ProcessorApi
|
|
499
499
|
*/
|
|
500
|
-
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
500
|
+
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
|
|
501
501
|
}
|
package/dist/api.js
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* File Processor API
|
|
6
|
-
* RIP file processor
|
|
6
|
+
* RIP file processor
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.3.3
|
|
7
9
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.3.1
|
|
9
|
-
* Contact: hello@teemill.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
12
|
* https://openapi-generator.tech
|
|
@@ -186,7 +186,7 @@ const ProcessorApiAxiosParamCreator = function (configuration) {
|
|
|
186
186
|
* @param {*} [options] Override http request option.
|
|
187
187
|
* @throws {RequiredError}
|
|
188
188
|
*/
|
|
189
|
-
deleteJob: (job_1,
|
|
189
|
+
deleteJob: (job_1, project_1, ...args_1) => __awaiter(this, [job_1, project_1, ...args_1], void 0, function* (job, project, options = {}) {
|
|
190
190
|
// verify required parameter 'job' is not null or undefined
|
|
191
191
|
(0, common_1.assertParamExists)('deleteJob', 'job', job);
|
|
192
192
|
// verify required parameter 'project' is not null or undefined
|
|
@@ -226,7 +226,7 @@ const ProcessorApiAxiosParamCreator = function (configuration) {
|
|
|
226
226
|
* @param {*} [options] Override http request option.
|
|
227
227
|
* @throws {RequiredError}
|
|
228
228
|
*/
|
|
229
|
-
getJob: (
|
|
229
|
+
getJob: (job_1, project_1, ...args_1) => __awaiter(this, [job_1, project_1, ...args_1], void 0, function* (job, project, options = {}) {
|
|
230
230
|
// verify required parameter 'job' is not null or undefined
|
|
231
231
|
(0, common_1.assertParamExists)('getJob', 'job', job);
|
|
232
232
|
// verify required parameter 'project' is not null or undefined
|
|
@@ -267,7 +267,7 @@ const ProcessorApiAxiosParamCreator = function (configuration) {
|
|
|
267
267
|
* @param {*} [options] Override http request option.
|
|
268
268
|
* @throws {RequiredError}
|
|
269
269
|
*/
|
|
270
|
-
listJobs: (
|
|
270
|
+
listJobs: (project_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, pageToken, pageSize, options = {}) {
|
|
271
271
|
// verify required parameter 'project' is not null or undefined
|
|
272
272
|
(0, common_1.assertParamExists)('listJobs', 'project', project);
|
|
273
273
|
const localVarPath = `/jobs`;
|
package/dist/base.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
package/dist/base.js
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* File Processor API
|
|
6
|
-
* RIP file processor
|
|
6
|
+
* RIP file processor
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.3.3
|
|
7
9
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.3.1
|
|
9
|
-
* Contact: hello@teemill.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
12
|
* https://openapi-generator.tech
|
package/dist/common.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/common.js
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* File Processor API
|
|
6
|
-
* RIP file processor
|
|
6
|
+
* RIP file processor
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.3.3
|
|
7
9
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.3.1
|
|
9
|
-
* Contact: hello@teemill.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
12
|
* https://openapi-generator.tech
|
package/dist/configuration.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
package/dist/configuration.js
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* File Processor API
|
|
6
|
-
* RIP file processor
|
|
6
|
+
* RIP file processor
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.3.3
|
|
7
9
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.3.1
|
|
9
|
-
* Contact: hello@teemill.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
12
|
* https://openapi-generator.tech
|
|
@@ -16,13 +16,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
16
16
|
exports.Configuration = void 0;
|
|
17
17
|
class Configuration {
|
|
18
18
|
constructor(param = {}) {
|
|
19
|
+
var _a;
|
|
19
20
|
this.apiKey = param.apiKey;
|
|
20
21
|
this.username = param.username;
|
|
21
22
|
this.password = param.password;
|
|
22
23
|
this.accessToken = param.accessToken;
|
|
23
24
|
this.basePath = param.basePath;
|
|
24
25
|
this.serverIndex = param.serverIndex;
|
|
25
|
-
this.baseOptions = param.baseOptions;
|
|
26
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
26
27
|
this.formDataCtor = param.formDataCtor;
|
|
27
28
|
}
|
|
28
29
|
/**
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -70,6 +70,25 @@ export interface GetHealth200Response {
|
|
|
70
70
|
*/
|
|
71
71
|
'status'?: string;
|
|
72
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
*
|
|
75
|
+
* @export
|
|
76
|
+
* @interface InlineObject
|
|
77
|
+
*/
|
|
78
|
+
export interface InlineObject {
|
|
79
|
+
/**
|
|
80
|
+
*
|
|
81
|
+
* @type {Array<Job>}
|
|
82
|
+
* @memberof InlineObject
|
|
83
|
+
*/
|
|
84
|
+
'jobs': Array<Job>;
|
|
85
|
+
/**
|
|
86
|
+
*
|
|
87
|
+
* @type {number}
|
|
88
|
+
* @memberof InlineObject
|
|
89
|
+
*/
|
|
90
|
+
'nextPageToken': number;
|
|
91
|
+
}
|
|
73
92
|
/**
|
|
74
93
|
*
|
|
75
94
|
* @export
|
|
@@ -175,25 +194,6 @@ export interface JobOutput {
|
|
|
175
194
|
*/
|
|
176
195
|
'thumbnail': string;
|
|
177
196
|
}
|
|
178
|
-
/**
|
|
179
|
-
*
|
|
180
|
-
* @export
|
|
181
|
-
* @interface ListJobs200Response
|
|
182
|
-
*/
|
|
183
|
-
export interface ListJobs200Response {
|
|
184
|
-
/**
|
|
185
|
-
*
|
|
186
|
-
* @type {Array<Job>}
|
|
187
|
-
* @memberof ListJobs200Response
|
|
188
|
-
*/
|
|
189
|
-
'jobs': Array<Job>;
|
|
190
|
-
/**
|
|
191
|
-
*
|
|
192
|
-
* @type {number}
|
|
193
|
-
* @memberof ListJobs200Response
|
|
194
|
-
*/
|
|
195
|
-
'nextPageToken': number;
|
|
196
|
-
}
|
|
197
197
|
/**
|
|
198
198
|
* HealthApi - axios parameter creator
|
|
199
199
|
* @export
|
|
@@ -333,7 +333,7 @@ export declare const ProcessorApiFp: (configuration?: Configuration) => {
|
|
|
333
333
|
* @param {*} [options] Override http request option.
|
|
334
334
|
* @throws {RequiredError}
|
|
335
335
|
*/
|
|
336
|
-
listJobs(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
336
|
+
listJobs(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
|
|
337
337
|
};
|
|
338
338
|
/**
|
|
339
339
|
* ProcessorApi - factory interface
|
|
@@ -371,7 +371,7 @@ export declare const ProcessorApiFactory: (configuration?: Configuration, basePa
|
|
|
371
371
|
* @param {*} [options] Override http request option.
|
|
372
372
|
* @throws {RequiredError}
|
|
373
373
|
*/
|
|
374
|
-
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
374
|
+
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
|
|
375
375
|
};
|
|
376
376
|
/**
|
|
377
377
|
* Request parameters for createJob operation in ProcessorApi.
|
|
@@ -497,5 +497,5 @@ export declare class ProcessorApi extends BaseAPI {
|
|
|
497
497
|
* @throws {RequiredError}
|
|
498
498
|
* @memberof ProcessorApi
|
|
499
499
|
*/
|
|
500
|
-
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
500
|
+
listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
|
|
501
501
|
}
|
package/dist/esm/api.js
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
6
8
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.1
|
|
8
|
-
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
@@ -179,7 +179,7 @@ export const ProcessorApiAxiosParamCreator = function (configuration) {
|
|
|
179
179
|
* @param {*} [options] Override http request option.
|
|
180
180
|
* @throws {RequiredError}
|
|
181
181
|
*/
|
|
182
|
-
deleteJob: (job_1,
|
|
182
|
+
deleteJob: (job_1, project_1, ...args_1) => __awaiter(this, [job_1, project_1, ...args_1], void 0, function* (job, project, options = {}) {
|
|
183
183
|
// verify required parameter 'job' is not null or undefined
|
|
184
184
|
assertParamExists('deleteJob', 'job', job);
|
|
185
185
|
// verify required parameter 'project' is not null or undefined
|
|
@@ -219,7 +219,7 @@ export const ProcessorApiAxiosParamCreator = function (configuration) {
|
|
|
219
219
|
* @param {*} [options] Override http request option.
|
|
220
220
|
* @throws {RequiredError}
|
|
221
221
|
*/
|
|
222
|
-
getJob: (
|
|
222
|
+
getJob: (job_1, project_1, ...args_1) => __awaiter(this, [job_1, project_1, ...args_1], void 0, function* (job, project, options = {}) {
|
|
223
223
|
// verify required parameter 'job' is not null or undefined
|
|
224
224
|
assertParamExists('getJob', 'job', job);
|
|
225
225
|
// verify required parameter 'project' is not null or undefined
|
|
@@ -260,7 +260,7 @@ export const ProcessorApiAxiosParamCreator = function (configuration) {
|
|
|
260
260
|
* @param {*} [options] Override http request option.
|
|
261
261
|
* @throws {RequiredError}
|
|
262
262
|
*/
|
|
263
|
-
listJobs: (
|
|
263
|
+
listJobs: (project_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, pageToken, pageSize, options = {}) {
|
|
264
264
|
// verify required parameter 'project' is not null or undefined
|
|
265
265
|
assertParamExists('listJobs', 'project', project);
|
|
266
266
|
const localVarPath = `/jobs`;
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
package/dist/esm/base.js
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
6
8
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.1
|
|
8
|
-
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/esm/common.js
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
6
8
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.1
|
|
8
|
-
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
6
8
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.1
|
|
8
|
-
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
@@ -13,13 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
export class Configuration {
|
|
15
15
|
constructor(param = {}) {
|
|
16
|
+
var _a;
|
|
16
17
|
this.apiKey = param.apiKey;
|
|
17
18
|
this.username = param.username;
|
|
18
19
|
this.password = param.password;
|
|
19
20
|
this.accessToken = param.accessToken;
|
|
20
21
|
this.basePath = param.basePath;
|
|
21
22
|
this.serverIndex = param.serverIndex;
|
|
22
|
-
this.baseOptions = param.baseOptions;
|
|
23
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
23
24
|
this.formDataCtor = param.formDataCtor;
|
|
24
25
|
}
|
|
25
26
|
/**
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
package/dist/esm/index.js
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
6
8
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.1
|
|
8
|
-
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* File Processor API
|
|
3
|
-
* RIP file processor
|
|
3
|
+
* RIP file processor
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.3.3
|
|
4
6
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.1
|
|
6
|
-
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
package/dist/index.js
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* File Processor API
|
|
6
|
-
* RIP file processor
|
|
6
|
+
* RIP file processor
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.3.3
|
|
7
9
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.3.1
|
|
9
|
-
* Contact: hello@teemill.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
12
|
* https://openapi-generator.tech
|
package/docs/ApiError.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApiError } from '@teemill/file-processor';
|
|
15
|
+
|
|
16
|
+
const instance: ApiError = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreateJobRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**input** | [**JobInput**](JobInput.md) | | [default to undefined]
|
|
9
|
+
**pipeline** | **string** | | [default to undefined]
|
|
10
|
+
**configuration** | **object** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateJobRequest } from '@teemill/file-processor';
|
|
16
|
+
|
|
17
|
+
const instance: CreateJobRequest = {
|
|
18
|
+
input,
|
|
19
|
+
pipeline,
|
|
20
|
+
configuration,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GetHealth200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GetHealth200Response } from '@teemill/file-processor';
|
|
14
|
+
|
|
15
|
+
const instance: GetHealth200Response = {
|
|
16
|
+
status,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# HealthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.localhost:8080*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getHealth**](#gethealth) | **GET** /healthz | Get health|
|
|
8
|
+
|
|
9
|
+
# **getHealth**
|
|
10
|
+
> GetHealth200Response getHealth()
|
|
11
|
+
|
|
12
|
+
Get api health
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
HealthApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@teemill/file-processor';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new HealthApi(configuration);
|
|
24
|
+
|
|
25
|
+
const { status, data } = await apiInstance.getHealth();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Parameters
|
|
29
|
+
This endpoint does not have any parameters.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Return type
|
|
33
|
+
|
|
34
|
+
**GetHealth200Response**
|
|
35
|
+
|
|
36
|
+
### Authorization
|
|
37
|
+
|
|
38
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
39
|
+
|
|
40
|
+
### HTTP request headers
|
|
41
|
+
|
|
42
|
+
- **Content-Type**: Not defined
|
|
43
|
+
- **Accept**: application/json
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### HTTP response details
|
|
47
|
+
| Status code | Description | Response headers |
|
|
48
|
+
|-------------|-------------|------------------|
|
|
49
|
+
|**200** | API Health | - |
|
|
50
|
+
|**400** | Failed validation | - |
|
|
51
|
+
|
|
52
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
53
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# InlineObject
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**jobs** | [**Array<Job>**](Job.md) | | [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { InlineObject } from '@teemill/file-processor';
|
|
15
|
+
|
|
16
|
+
const instance: InlineObject = {
|
|
17
|
+
jobs,
|
|
18
|
+
nextPageToken,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Job.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Job
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [readonly] [default to undefined]
|
|
9
|
+
**project** | **string** | | [readonly] [default to undefined]
|
|
10
|
+
**input** | [**JobInput**](JobInput.md) | | [default to undefined]
|
|
11
|
+
**output** | [**JobOutput**](JobOutput.md) | | [default to undefined]
|
|
12
|
+
**pipeline** | **string** | | [default to undefined]
|
|
13
|
+
**configuration** | **object** | | [default to undefined]
|
|
14
|
+
**createdAt** | **string** | ISO 8601 Timestamp | [readonly] [default to undefined]
|
|
15
|
+
**startedAt** | **string** | ISO 8601 Timestamp | [optional] [readonly] [default to undefined]
|
|
16
|
+
**completedAt** | **string** | ISO 8601 Timestamp | [optional] [readonly] [default to undefined]
|
|
17
|
+
**failedAt** | **string** | ISO 8601 Timestamp | [optional] [readonly] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { Job } from '@teemill/file-processor';
|
|
23
|
+
|
|
24
|
+
const instance: Job = {
|
|
25
|
+
id,
|
|
26
|
+
project,
|
|
27
|
+
input,
|
|
28
|
+
output,
|
|
29
|
+
pipeline,
|
|
30
|
+
configuration,
|
|
31
|
+
createdAt,
|
|
32
|
+
startedAt,
|
|
33
|
+
completedAt,
|
|
34
|
+
failedAt,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/JobInput.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# JobInput
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**path** | **string** | | [default to undefined]
|
|
9
|
+
**driver** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { JobInput } from '@teemill/file-processor';
|
|
15
|
+
|
|
16
|
+
const instance: JobInput = {
|
|
17
|
+
path,
|
|
18
|
+
driver,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# JobOutput
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**source** | **string** | | [default to undefined]
|
|
9
|
+
**thumbnail** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { JobOutput } from '@teemill/file-processor';
|
|
15
|
+
|
|
16
|
+
const instance: JobOutput = {
|
|
17
|
+
source,
|
|
18
|
+
thumbnail,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
# ProcessorApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.localhost:8080*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createJob**](#createjob) | **POST** /jobs | Create job|
|
|
8
|
+
|[**deleteJob**](#deletejob) | **DELETE** /jobs/{job} | Delete job|
|
|
9
|
+
|[**getJob**](#getjob) | **GET** /jobs/{job} | Get job|
|
|
10
|
+
|[**listJobs**](#listjobs) | **GET** /jobs | List jobs|
|
|
11
|
+
|
|
12
|
+
# **createJob**
|
|
13
|
+
> Job createJob(createJobRequest)
|
|
14
|
+
|
|
15
|
+
Create a new processor job
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
ProcessorApi,
|
|
22
|
+
Configuration,
|
|
23
|
+
CreateJobRequest
|
|
24
|
+
} from '@teemill/file-processor';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new ProcessorApi(configuration);
|
|
28
|
+
|
|
29
|
+
let project: string; //Projects unique identifier (default to undefined)
|
|
30
|
+
let createJobRequest: CreateJobRequest; //Create a new job
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.createJob(
|
|
33
|
+
project,
|
|
34
|
+
createJobRequest
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **createJobRequest** | **CreateJobRequest**| Create a new job | |
|
|
43
|
+
| **project** | [**string**] | Projects unique identifier | defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
**Job**
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: application/json
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**200** | Single job | - |
|
|
64
|
+
|**400** | Failed validation | - |
|
|
65
|
+
|**401** | Not authorised to access this resource | - |
|
|
66
|
+
|**403** | Refuse to authorize | - |
|
|
67
|
+
|**500** | Unknown server error | - |
|
|
68
|
+
|
|
69
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
70
|
+
|
|
71
|
+
# **deleteJob**
|
|
72
|
+
> deleteJob()
|
|
73
|
+
|
|
74
|
+
Delete a processor job
|
|
75
|
+
|
|
76
|
+
### Example
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
import {
|
|
80
|
+
ProcessorApi,
|
|
81
|
+
Configuration
|
|
82
|
+
} from '@teemill/file-processor';
|
|
83
|
+
|
|
84
|
+
const configuration = new Configuration();
|
|
85
|
+
const apiInstance = new ProcessorApi(configuration);
|
|
86
|
+
|
|
87
|
+
let job: string; //Jobs unique identifier (default to undefined)
|
|
88
|
+
let project: string; //Projects unique identifier (default to undefined)
|
|
89
|
+
|
|
90
|
+
const { status, data } = await apiInstance.deleteJob(
|
|
91
|
+
job,
|
|
92
|
+
project
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **job** | [**string**] | Jobs unique identifier | defaults to undefined|
|
|
101
|
+
| **project** | [**string**] | Projects unique identifier | defaults to undefined|
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
### Return type
|
|
105
|
+
|
|
106
|
+
void (empty response body)
|
|
107
|
+
|
|
108
|
+
### Authorization
|
|
109
|
+
|
|
110
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
111
|
+
|
|
112
|
+
### HTTP request headers
|
|
113
|
+
|
|
114
|
+
- **Content-Type**: Not defined
|
|
115
|
+
- **Accept**: application/json
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### HTTP response details
|
|
119
|
+
| Status code | Description | Response headers |
|
|
120
|
+
|-------------|-------------|------------------|
|
|
121
|
+
|**200** | Job Deleted | - |
|
|
122
|
+
|**400** | Failed validation | - |
|
|
123
|
+
|**401** | Not authorised to access this resource | - |
|
|
124
|
+
|**403** | Refuse to authorize | - |
|
|
125
|
+
|**404** | Resource not found | - |
|
|
126
|
+
|**500** | Unknown server error | - |
|
|
127
|
+
|
|
128
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
129
|
+
|
|
130
|
+
# **getJob**
|
|
131
|
+
> Job getJob()
|
|
132
|
+
|
|
133
|
+
Get a job
|
|
134
|
+
|
|
135
|
+
### Example
|
|
136
|
+
|
|
137
|
+
```typescript
|
|
138
|
+
import {
|
|
139
|
+
ProcessorApi,
|
|
140
|
+
Configuration
|
|
141
|
+
} from '@teemill/file-processor';
|
|
142
|
+
|
|
143
|
+
const configuration = new Configuration();
|
|
144
|
+
const apiInstance = new ProcessorApi(configuration);
|
|
145
|
+
|
|
146
|
+
let job: string; //Jobs unique identifier (default to undefined)
|
|
147
|
+
let project: string; //Projects unique identifier (default to undefined)
|
|
148
|
+
|
|
149
|
+
const { status, data } = await apiInstance.getJob(
|
|
150
|
+
job,
|
|
151
|
+
project
|
|
152
|
+
);
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
|Name | Type | Description | Notes|
|
|
158
|
+
|------------- | ------------- | ------------- | -------------|
|
|
159
|
+
| **job** | [**string**] | Jobs unique identifier | defaults to undefined|
|
|
160
|
+
| **project** | [**string**] | Projects unique identifier | defaults to undefined|
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
**Job**
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: Not defined
|
|
174
|
+
- **Accept**: application/json
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
### HTTP response details
|
|
178
|
+
| Status code | Description | Response headers |
|
|
179
|
+
|-------------|-------------|------------------|
|
|
180
|
+
|**200** | Single job | - |
|
|
181
|
+
|**400** | Failed validation | - |
|
|
182
|
+
|**401** | Not authorised to access this resource | - |
|
|
183
|
+
|**403** | Refuse to authorize | - |
|
|
184
|
+
|**404** | Resource not found | - |
|
|
185
|
+
|**500** | Unknown server error | - |
|
|
186
|
+
|
|
187
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
188
|
+
|
|
189
|
+
# **listJobs**
|
|
190
|
+
> InlineObject listJobs()
|
|
191
|
+
|
|
192
|
+
List your processor jobs
|
|
193
|
+
|
|
194
|
+
### Example
|
|
195
|
+
|
|
196
|
+
```typescript
|
|
197
|
+
import {
|
|
198
|
+
ProcessorApi,
|
|
199
|
+
Configuration
|
|
200
|
+
} from '@teemill/file-processor';
|
|
201
|
+
|
|
202
|
+
const configuration = new Configuration();
|
|
203
|
+
const apiInstance = new ProcessorApi(configuration);
|
|
204
|
+
|
|
205
|
+
let project: string; //Projects unique identifier (default to undefined)
|
|
206
|
+
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
207
|
+
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
208
|
+
|
|
209
|
+
const { status, data } = await apiInstance.listJobs(
|
|
210
|
+
project,
|
|
211
|
+
pageToken,
|
|
212
|
+
pageSize
|
|
213
|
+
);
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### Parameters
|
|
217
|
+
|
|
218
|
+
|Name | Type | Description | Notes|
|
|
219
|
+
|------------- | ------------- | ------------- | -------------|
|
|
220
|
+
| **project** | [**string**] | Projects unique identifier | defaults to undefined|
|
|
221
|
+
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
222
|
+
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
### Return type
|
|
226
|
+
|
|
227
|
+
**InlineObject**
|
|
228
|
+
|
|
229
|
+
### Authorization
|
|
230
|
+
|
|
231
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
232
|
+
|
|
233
|
+
### HTTP request headers
|
|
234
|
+
|
|
235
|
+
- **Content-Type**: Not defined
|
|
236
|
+
- **Accept**: application/json
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
### HTTP response details
|
|
240
|
+
| Status code | Description | Response headers |
|
|
241
|
+
|-------------|-------------|------------------|
|
|
242
|
+
|**200** | List of jobs | - |
|
|
243
|
+
|**400** | Failed validation | - |
|
|
244
|
+
|**401** | Not authorised to access this resource | - |
|
|
245
|
+
|**403** | Refuse to authorize | - |
|
|
246
|
+
|**500** | Unknown server error | - |
|
|
247
|
+
|
|
248
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
249
|
+
|
package/index.ts
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* File Processor API
|
|
5
|
-
* RIP file processor
|
|
5
|
+
* RIP file processor
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.3.
|
|
8
|
-
*
|
|
7
|
+
* The version of the OpenAPI document: 0.3.3
|
|
8
|
+
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|