@teemill/file-processor 0.1.0

package/dist/api.d.ts

@@ -0,0 +1,390 @@
+/**
+ * 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 type { RequestArgs } from './base';
+import { BaseAPI } 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 declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get api health
+     * @summary Get health
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHealth: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * HealthApi - functional programming interface
+ * @export
+ */
+export declare const HealthApiFp: (configuration?: Configuration) => {
+    /**
+     * Get api health
+     * @summary Get health
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetHealth200Response>>;
+};
+/**
+ * HealthApi - factory interface
+ * @export
+ */
+export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get api health
+     * @summary Get health
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getHealth(options?: any): AxiosPromise<GetHealth200Response>;
+};
+/**
+ * HealthApi - object-oriented interface
+ * @export
+ * @class HealthApi
+ * @extends {BaseAPI}
+ */
+export declare class HealthApi extends BaseAPI {
+    /**
+     * Get api health
+     * @summary Get health
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HealthApi
+     */
+    getHealth(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetHealth200Response, any>>;
+}
+/**
+ * ProcessorApi - axios parameter creator
+ * @export
+ */
+export declare const ProcessorApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProcessorApi - functional programming interface
+ * @export
+ */
+export declare const ProcessorApiFp: (configuration?: Configuration) => {
+    /**
+     * 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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>>;
+    /**
+     * 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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * 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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>>;
+    /**
+     * 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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListJobs200Response>>;
+};
+/**
+ * ProcessorApi - factory interface
+ * @export
+ */
+export declare const ProcessorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+};
+/**
+ * ProcessorApi - object-oriented interface
+ * @export
+ * @class ProcessorApi
+ * @extends {BaseAPI}
+ */
+export declare 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
+     */
+    createJob(project: string, job: Job, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Job, any>>;
+    /**
+     * 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
+     */
+    deleteJob(job: string, project: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * 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
+     */
+    getJob(job: string, project: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Job, any>>;
+    /**
+     * List your processor jobs
+     * @summary List jobs
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProcessorApi
+     */
+    listJobs(project: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListJobs200Response, any>>;
+}