@teemill/file-processor 0.1.0

package/api.ts

@@ -0,0 +1,662 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * File Processor API
+ * RIP file processor   For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
+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 GetHealth200Response
+ */
+export interface GetHealth200Response {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetHealth200Response
+     */
+    'status'?: string;
+}
+/**
+ * 
+ * @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;
+    /**
+     * 
+     * @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
+     */
+    'path': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof JobOutput
+     */
+    'driver': string;
+}
+/**
+ * 
+ * @export
+ * @interface ListJobs200Response
+ */
+export interface ListJobs200Response {
+    /**
+     * 
+     * @type {Array<Job>}
+     * @memberof ListJobs200Response
+     */
+    'jobs': Array<Job>;
+}
+
+/**
+ * HealthApi - axios parameter creator
+ * @export
+ */
+export const HealthApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Get api health
+         * @summary Get health
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHealth: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/healthz`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * HealthApi - functional programming interface
+ * @export
+ */
+export const HealthApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Get api health
+         * @summary Get health
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetHealth200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getHealth(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['HealthApi.getHealth']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * HealthApi - factory interface
+ * @export
+ */
+export const HealthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = HealthApiFp(configuration)
+    return {
+        /**
+         * Get api health
+         * @summary Get health
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHealth(options?: any): AxiosPromise<GetHealth200Response> {
+            return localVarFp.getHealth(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * HealthApi - object-oriented interface
+ * @export
+ * @class HealthApi
+ * @extends {BaseAPI}
+ */
+export class HealthApi extends BaseAPI {
+    /**
+     * Get api health
+     * @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));
+    }
+}
+
+
+
+/**
+ * ProcessorApi - axios parameter creator
+ * @export
+ */
+export const ProcessorApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Create a new processor job
+         * @summary Create job
+         * @param {string} project Projects unique identifier
+         * @param {Job} job Create a new job
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createJob: async (project: string, job: Job, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('createJob', 'project', project)
+            // verify required parameter 'job' is not null or undefined
+            assertParamExists('createJob', 'job', job)
+            const localVarPath = `/jobs`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(job, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Delete a processor job
+         * @summary Delete job
+         * @param {string} job Jobs unique identifier
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteJob: async (job: string, project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'job' is not null or undefined
+            assertParamExists('deleteJob', 'job', job)
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('deleteJob', 'project', project)
+            const localVarPath = `/jobs/{job}`
+                .replace(`{${"job"}}`, encodeURIComponent(String(job)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get a job
+         * @summary Get job
+         * @param {string} job Jobs unique identifier
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getJob: async (job: string, project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'job' is not null or undefined
+            assertParamExists('getJob', 'job', job)
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getJob', 'project', project)
+            const localVarPath = `/jobs/{job}`
+                .replace(`{${"job"}}`, encodeURIComponent(String(job)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * List your processor jobs
+         * @summary List jobs
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listJobs: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('listJobs', 'project', project)
+            const localVarPath = `/jobs`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * ProcessorApi - functional programming interface
+ * @export
+ */
+export const ProcessorApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ProcessorApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Create a new processor job
+         * @summary Create job
+         * @param {string} project Projects unique identifier
+         * @param {Job} job Create a new job
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createJob(project: string, job: Job, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createJob(project, job, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProcessorApi.createJob']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Delete a processor job
+         * @summary Delete job
+         * @param {string} job Jobs unique identifier
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteJob(job: string, project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteJob(job, project, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProcessorApi.deleteJob']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Get a job
+         * @summary Get job
+         * @param {string} job Jobs unique identifier
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getJob(job: string, project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getJob(job, project, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProcessorApi.getJob']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * List your processor jobs
+         * @summary List jobs
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listJobs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListJobs200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listJobs(project, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProcessorApi.listJobs']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * ProcessorApi - factory interface
+ * @export
+ */
+export const ProcessorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ProcessorApiFp(configuration)
+    return {
+        /**
+         * Create a new processor job
+         * @summary Create job
+         * @param {string} project Projects unique identifier
+         * @param {Job} job Create a new job
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createJob(project: string, job: Job, options?: any): AxiosPromise<Job> {
+            return localVarFp.createJob(project, job, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Delete a processor job
+         * @summary Delete job
+         * @param {string} job Jobs unique identifier
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteJob(job: string, project: string, options?: any): AxiosPromise<void> {
+            return localVarFp.deleteJob(job, project, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Get a job
+         * @summary Get job
+         * @param {string} job Jobs unique identifier
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getJob(job: string, project: string, options?: any): AxiosPromise<Job> {
+            return localVarFp.getJob(job, project, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List your processor jobs
+         * @summary List jobs
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listJobs(project: string, options?: any): AxiosPromise<ListJobs200Response> {
+            return localVarFp.listJobs(project, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * ProcessorApi - object-oriented interface
+ * @export
+ * @class ProcessorApi
+ * @extends {BaseAPI}
+ */
+export class ProcessorApi extends BaseAPI {
+    /**
+     * Create a new processor job
+     * @summary Create job
+     * @param {string} project Projects unique identifier
+     * @param {Job} job Create a new job
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessorApi
+     */
+    public createJob(project: string, job: Job, options?: RawAxiosRequestConfig) {
+        return ProcessorApiFp(this.configuration).createJob(project, job, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Delete a processor job
+     * @summary Delete job
+     * @param {string} job Jobs unique identifier
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessorApi
+     */
+    public deleteJob(job: string, project: string, options?: RawAxiosRequestConfig) {
+        return ProcessorApiFp(this.configuration).deleteJob(job, project, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Get a job
+     * @summary Get job
+     * @param {string} job Jobs unique identifier
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessorApi
+     */
+    public getJob(job: string, project: string, options?: RawAxiosRequestConfig) {
+        return ProcessorApiFp(this.configuration).getJob(job, project, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * List your processor jobs
+     * @summary List jobs
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessorApi
+     */
+    public listJobs(project: string, options?: RawAxiosRequestConfig) {
+        return ProcessorApiFp(this.configuration).listJobs(project, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+