@teemill/file-processor 0.3.3 → 0.3.5

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/file-processor@0.3.3
+## @teemill/file-processor@0.3.5
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/file-processor@0.3.3 --save
+npm install @teemill/file-processor@0.3.5 --save
 ```
 
 _unPublished (not recommended):_
@@ -63,10 +63,10 @@ Class | Method | HTTP request | Description
  - [ApiError](docs/ApiError.md)
  - [CreateJobRequest](docs/CreateJobRequest.md)
  - [GetHealth200Response](docs/GetHealth200Response.md)
- - [InlineObject](docs/InlineObject.md)
  - [Job](docs/Job.md)
  - [JobInput](docs/JobInput.md)
  - [JobOutput](docs/JobOutput.md)
+ - [ListJobs200Response](docs/ListJobs200Response.md)
 
 
 <a id="documentation-for-authorization"></a>

package/api.ts

@@ -4,7 +4,7 @@
  * File Processor API
  * RIP file processor
  *
- * The version of the OpenAPI document: 0.3.3
+ * The version of the OpenAPI document: 0.3.5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,191 +23,57 @@ import type { RequestArgs } from './base';
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
 
-/**
- * 
- * @export
- * @interface ApiError
- */
 export interface ApiError {
-    /**
-     * 
-     * @type {string}
-     * @memberof ApiError
-     */
     'code'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof ApiError
-     */
     'message': string;
 }
-/**
- * 
- * @export
- * @interface CreateJobRequest
- */
 export interface CreateJobRequest {
-    /**
-     * 
-     * @type {JobInput}
-     * @memberof CreateJobRequest
-     */
     'input': JobInput;
-    /**
-     * 
-     * @type {string}
-     * @memberof CreateJobRequest
-     */
     'pipeline': string;
-    /**
-     * 
-     * @type {object}
-     * @memberof CreateJobRequest
-     */
     'configuration': object;
 }
-/**
- * 
- * @export
- * @interface GetHealth200Response
- */
 export interface GetHealth200Response {
-    /**
-     * 
-     * @type {string}
-     * @memberof GetHealth200Response
-     */
     'status'?: string;
 }
-/**
- * 
- * @export
- * @interface InlineObject
- */
-export interface InlineObject {
-    /**
-     * 
-     * @type {Array<Job>}
-     * @memberof InlineObject
-     */
-    'jobs': Array<Job>;
-    /**
-     * 
-     * @type {number}
-     * @memberof InlineObject
-     */
-    'nextPageToken': number;
-}
-/**
- * 
- * @export
- * @interface Job
- */
 export interface Job {
-    /**
-     * 
-     * @type {string}
-     * @memberof Job
-     */
     'id': string;
-    /**
-     * 
-     * @type {string}
-     * @memberof Job
-     */
     'project': string;
-    /**
-     * 
-     * @type {JobInput}
-     * @memberof Job
-     */
     'input': JobInput;
-    /**
-     * 
-     * @type {JobOutput}
-     * @memberof Job
-     */
     'output': JobOutput | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof Job
-     */
     'pipeline': string;
-    /**
-     * 
-     * @type {object}
-     * @memberof Job
-     */
     'configuration': object;
     /**
      * ISO 8601 Timestamp
-     * @type {string}
-     * @memberof Job
      */
     'createdAt': string;
     /**
      * ISO 8601 Timestamp
-     * @type {string}
-     * @memberof Job
      */
     'startedAt'?: string;
     /**
      * ISO 8601 Timestamp
-     * @type {string}
-     * @memberof Job
      */
     'completedAt'?: string;
     /**
      * ISO 8601 Timestamp
-     * @type {string}
-     * @memberof Job
      */
     'failedAt'?: string;
 }
-/**
- * 
- * @export
- * @interface JobInput
- */
 export interface JobInput {
-    /**
-     * 
-     * @type {string}
-     * @memberof JobInput
-     */
     'path': string;
-    /**
-     * 
-     * @type {string}
-     * @memberof JobInput
-     */
     'driver': string;
 }
-/**
- * 
- * @export
- * @interface JobOutput
- */
 export interface JobOutput {
-    /**
-     * 
-     * @type {string}
-     * @memberof JobOutput
-     */
     'source': string;
-    /**
-     * 
-     * @type {string}
-     * @memberof JobOutput
-     */
     'thumbnail': string;
 }
+export interface ListJobs200Response {
+    'jobs': Array<Job>;
+    'nextPageToken': number;
+}
 
 /**
  * HealthApi - axios parameter creator
- * @export
  */
 export const HealthApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
@@ -253,7 +119,6 @@ export const HealthApiAxiosParamCreator = function (configuration?: Configuratio
 
 /**
  * HealthApi - functional programming interface
- * @export
  */
 export const HealthApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration)
@@ -275,7 +140,6 @@ export const HealthApiFp = function(configuration?: Configuration) {
 
 /**
  * HealthApi - factory interface
- * @export
  */
 export const HealthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = HealthApiFp(configuration)
@@ -294,9 +158,6 @@ export const HealthApiFactory = function (configuration?: Configuration, basePat
 
 /**
  * HealthApi - object-oriented interface
- * @export
- * @class HealthApi
- * @extends {BaseAPI}
  */
 export class HealthApi extends BaseAPI {
     /**
@@ -304,7 +165,6 @@ export class HealthApi extends BaseAPI {
      * @summary Get health
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof HealthApi
      */
     public getHealth(options?: RawAxiosRequestConfig) {
         return HealthApiFp(this.configuration).getHealth(options).then((request) => request(this.axios, this.basePath));
@@ -315,7 +175,6 @@ export class HealthApi extends BaseAPI {
 
 /**
  * ProcessorApi - axios parameter creator
- * @export
  */
 export const ProcessorApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
@@ -524,7 +383,6 @@ export const ProcessorApiAxiosParamCreator = function (configuration?: Configura
 
 /**
  * ProcessorApi - functional programming interface
- * @export
  */
 export const ProcessorApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = ProcessorApiAxiosParamCreator(configuration)
@@ -580,7 +438,7 @@ export const ProcessorApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listJobs(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>> {
+        async listJobs(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListJobs200Response>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listJobs(project, pageToken, pageSize, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ProcessorApi.listJobs']?.[localVarOperationServerIndex]?.url;
@@ -591,7 +449,6 @@ export const ProcessorApiFp = function(configuration?: Configuration) {
 
 /**
  * ProcessorApi - factory interface
- * @export
  */
 export const ProcessorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = ProcessorApiFp(configuration)
@@ -633,7 +490,7 @@ export const ProcessorApiFactory = function (configuration?: Configuration, base
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject> {
+        listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListJobs200Response> {
             return localVarFp.listJobs(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
         },
     };
@@ -641,100 +498,71 @@ export const ProcessorApiFactory = function (configuration?: Configuration, base
 
 /**
  * Request parameters for createJob operation in ProcessorApi.
- * @export
- * @interface ProcessorApiCreateJobRequest
  */
 export interface ProcessorApiCreateJobRequest {
     /**
      * Projects unique identifier
-     * @type {string}
-     * @memberof ProcessorApiCreateJob
      */
     readonly project: string
 
     /**
      * Create a new job
-     * @type {CreateJobRequest}
-     * @memberof ProcessorApiCreateJob
      */
     readonly createJobRequest: CreateJobRequest
 }
 
 /**
  * Request parameters for deleteJob operation in ProcessorApi.
- * @export
- * @interface ProcessorApiDeleteJobRequest
  */
 export interface ProcessorApiDeleteJobRequest {
     /**
      * Jobs unique identifier
-     * @type {string}
-     * @memberof ProcessorApiDeleteJob
      */
     readonly job: string
 
     /**
      * Projects unique identifier
-     * @type {string}
-     * @memberof ProcessorApiDeleteJob
      */
     readonly project: string
 }
 
 /**
  * Request parameters for getJob operation in ProcessorApi.
- * @export
- * @interface ProcessorApiGetJobRequest
  */
 export interface ProcessorApiGetJobRequest {
     /**
      * Jobs unique identifier
-     * @type {string}
-     * @memberof ProcessorApiGetJob
      */
     readonly job: string
 
     /**
      * Projects unique identifier
-     * @type {string}
-     * @memberof ProcessorApiGetJob
      */
     readonly project: string
 }
 
 /**
  * Request parameters for listJobs operation in ProcessorApi.
- * @export
- * @interface ProcessorApiListJobsRequest
  */
 export interface ProcessorApiListJobsRequest {
     /**
      * Projects unique identifier
-     * @type {string}
-     * @memberof ProcessorApiListJobs
      */
     readonly project: string
 
     /**
      * Page reference token
-     * @type {number}
-     * @memberof ProcessorApiListJobs
      */
     readonly pageToken?: number
 
     /**
      * Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @type {number}
-     * @memberof ProcessorApiListJobs
      */
     readonly pageSize?: number
 }
 
 /**
  * ProcessorApi - object-oriented interface
- * @export
- * @class ProcessorApi
- * @extends {BaseAPI}
  */
 export class ProcessorApi extends BaseAPI {
     /**
@@ -743,7 +571,6 @@ export class ProcessorApi extends BaseAPI {
      * @param {ProcessorApiCreateJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProcessorApi
      */
     public createJob(requestParameters: ProcessorApiCreateJobRequest, options?: RawAxiosRequestConfig) {
         return ProcessorApiFp(this.configuration).createJob(requestParameters.project, requestParameters.createJobRequest, options).then((request) => request(this.axios, this.basePath));
@@ -755,7 +582,6 @@ export class ProcessorApi extends BaseAPI {
      * @param {ProcessorApiDeleteJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProcessorApi
      */
     public deleteJob(requestParameters: ProcessorApiDeleteJobRequest, options?: RawAxiosRequestConfig) {
         return ProcessorApiFp(this.configuration).deleteJob(requestParameters.job, requestParameters.project, options).then((request) => request(this.axios, this.basePath));
@@ -767,7 +593,6 @@ export class ProcessorApi extends BaseAPI {
      * @param {ProcessorApiGetJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProcessorApi
      */
     public getJob(requestParameters: ProcessorApiGetJobRequest, options?: RawAxiosRequestConfig) {
         return ProcessorApiFp(this.configuration).getJob(requestParameters.job, requestParameters.project, options).then((request) => request(this.axios, this.basePath));
@@ -779,7 +604,6 @@ export class ProcessorApi extends BaseAPI {
      * @param {ProcessorApiListJobsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProcessorApi
      */
     public listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig) {
         return ProcessorApiFp(this.configuration).listJobs(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));

package/base.ts

@@ -4,7 +4,7 @@
  * File Processor API
  * RIP file processor
  *
- * The version of the OpenAPI document: 0.3.3
+ * The version of the OpenAPI document: 0.3.5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,10 +21,6 @@ import globalAxios from 'axios';
 
 export const BASE_PATH = "https://api.localhost:8080".replace(/\/+$/, "");
 
-/**
- *
- * @export
- */
 export const COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
@@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = {
     pipes: "|",
 };
 
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
 
-/**
- *
- * @export
- * @class BaseAPI
- */
 export class BaseAPI {
     protected configuration: Configuration | undefined;
 
@@ -58,12 +44,6 @@ export class BaseAPI {
     }
 };
 
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export class RequiredError extends Error {
     constructor(public field: string, msg?: string) {
         super(msg);
@@ -78,9 +58,5 @@ interface ServerMap {
     }[];
 }
 
-/**
- *
- * @export
- */
 export const operationServerMap: ServerMap = {
 }

package/common.ts

@@ -4,7 +4,7 @@
  * File Processor API
  * RIP file processor
  *
- * The version of the OpenAPI document: 0.3.3
+ * The version of the OpenAPI document: 0.3.5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,7 +12,6 @@
  * Do not edit the class manually.
  */
 
-
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';

package/configuration.ts

@@ -4,7 +4,7 @@
  * File Processor API
  * RIP file processor
  *
- * The version of the OpenAPI document: 0.3.3
+ * The version of the OpenAPI document: 0.3.5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,49 +28,32 @@ export class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**