@teemill/file-processor 0.1.1 → 0.2.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/file-processor@0.1.1
+## @teemill/file-processor@0.2.0
 
 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.1.1 --save
+npm install @teemill/file-processor@0.2.0 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * 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.1
+ * The version of the OpenAPI document: 0.2.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -203,6 +203,12 @@ export interface ListJobs200Response {
      * @memberof ListJobs200Response
      */
     'jobs': Array<Job>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListJobs200Response
+     */
+    'nextPageToken': number;
 }
 
 /**
@@ -286,7 +292,7 @@ export const HealthApiFactory = function (configuration?: Configuration, basePat
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getHealth(options?: any): AxiosPromise<GetHealth200Response> {
+        getHealth(options?: RawAxiosRequestConfig): AxiosPromise<GetHealth200Response> {
             return localVarFp.getHealth(options).then((request) => request(axios, basePath));
         },
     };
@@ -469,10 +475,12 @@ export const ProcessorApiAxiosParamCreator = function (configuration?: Configura
          * List your processor jobs
          * @summary List jobs
          * @param {string} project Projects unique identifier
+         * @param {number} [pageToken] Page reference token
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listJobs: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listJobs: async (project: string, pageToken?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'project' is not null or undefined
             assertParamExists('listJobs', 'project', project)
             const localVarPath = `/jobs`;
@@ -498,6 +506,14 @@ export const ProcessorApiAxiosParamCreator = function (configuration?: Configura
                 localVarQueryParameter['project'] = project;
             }
 
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -565,11 +581,13 @@ export const ProcessorApiFp = function(configuration?: Configuration) {
          * List your processor jobs
          * @summary List jobs
          * @param {string} project Projects unique identifier
+         * @param {number} [pageToken] Page reference token
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
          * @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);
+        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;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -587,49 +605,137 @@ export const ProcessorApiFactory = function (configuration?: Configuration, base
         /**
          * Create a new processor job
          * @summary Create job
-         * @param {string} project Projects unique identifier
-         * @param {CreateJobRequest} createJobRequest Create a new job
+         * @param {ProcessorApiCreateJobRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createJob(project: string, createJobRequest: CreateJobRequest, options?: any): AxiosPromise<Job> {
-            return localVarFp.createJob(project, createJobRequest, options).then((request) => request(axios, basePath));
+        createJob(requestParameters: ProcessorApiCreateJobRequest, options?: RawAxiosRequestConfig): AxiosPromise<Job> {
+            return localVarFp.createJob(requestParameters.project, requestParameters.createJobRequest, 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 {ProcessorApiDeleteJobRequest} requestParameters Request parameters.
          * @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));
+        deleteJob(requestParameters: ProcessorApiDeleteJobRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.deleteJob(requestParameters.job, requestParameters.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 {ProcessorApiGetJobRequest} requestParameters Request parameters.
          * @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));
+        getJob(requestParameters: ProcessorApiGetJobRequest, options?: RawAxiosRequestConfig): AxiosPromise<Job> {
+            return localVarFp.getJob(requestParameters.job, requestParameters.project, options).then((request) => request(axios, basePath));
         },
         /**
          * List your processor jobs
          * @summary List jobs
-         * @param {string} project Projects unique identifier
+         * @param {ProcessorApiListJobsRequest} requestParameters Request parameters.
          * @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));
+        listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListJobs200Response> {
+            return localVarFp.listJobs(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
         },
     };
 };
 
+/**
+ * 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
@@ -640,52 +746,49 @@ export class ProcessorApi extends BaseAPI {
     /**
      * Create a new processor job
      * @summary Create job
-     * @param {string} project Projects unique identifier
-     * @param {CreateJobRequest} createJobRequest Create a new job
+     * @param {ProcessorApiCreateJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProcessorApi
      */
-    public createJob(project: string, createJobRequest: CreateJobRequest, options?: RawAxiosRequestConfig) {
-        return ProcessorApiFp(this.configuration).createJob(project, createJobRequest, options).then((request) => request(this.axios, this.basePath));
+    public createJob(requestParameters: ProcessorApiCreateJobRequest, options?: RawAxiosRequestConfig) {
+        return ProcessorApiFp(this.configuration).createJob(requestParameters.project, requestParameters.createJobRequest, 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 {ProcessorApiDeleteJobRequest} requestParameters Request parameters.
      * @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));
+    public deleteJob(requestParameters: ProcessorApiDeleteJobRequest, options?: RawAxiosRequestConfig) {
+        return ProcessorApiFp(this.configuration).deleteJob(requestParameters.job, requestParameters.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 {ProcessorApiGetJobRequest} requestParameters Request parameters.
      * @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));
+    public getJob(requestParameters: ProcessorApiGetJobRequest, options?: RawAxiosRequestConfig) {
+        return ProcessorApiFp(this.configuration).getJob(requestParameters.job, requestParameters.project, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
      * List your processor jobs
      * @summary List jobs
-     * @param {string} project Projects unique identifier
+     * @param {ProcessorApiListJobsRequest} requestParameters Request parameters.
      * @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));
+    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   For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 0.1.1
+ * The version of the OpenAPI document: 0.2.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * 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.1
+ * The version of the OpenAPI document: 0.2.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * 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.1
+ * The version of the OpenAPI document: 0.2.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * 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.1
+ * The version of the OpenAPI document: 0.2.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -193,6 +193,12 @@ export interface ListJobs200Response {
      * @memberof ListJobs200Response
      */
     'jobs': Array<Job>;
+    /**
+     *
+     * @type {number}
+     * @memberof ListJobs200Response
+     */
+    'nextPageToken': number;
 }
 /**
  * HealthApi - axios parameter creator
@@ -231,7 +237,7 @@ export declare const HealthApiFactory: (configuration?: Configuration, basePath?
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getHealth(options?: any): AxiosPromise<GetHealth200Response>;
+    getHealth(options?: RawAxiosRequestConfig): AxiosPromise<GetHealth200Response>;
 };
 /**
  * HealthApi - object-oriented interface
@@ -285,10 +291,12 @@ export declare const ProcessorApiAxiosParamCreator: (configuration?: Configurati
      * List your processor jobs
      * @summary List jobs
      * @param {string} project Projects unique identifier
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listJobs: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listJobs: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ProcessorApi - functional programming interface
@@ -326,10 +334,12 @@ export declare const ProcessorApiFp: (configuration?: Configuration) => {
      * List your processor jobs
      * @summary List jobs
      * @param {string} project Projects unique identifier
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listJobs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListJobs200Response>>;
+    listJobs(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListJobs200Response>>;
 };
 /**
  * ProcessorApi - factory interface
@@ -339,39 +349,118 @@ export declare const ProcessorApiFactory: (configuration?: Configuration, basePa
     /**
      * Create a new processor job
      * @summary Create job
-     * @param {string} project Projects unique identifier
-     * @param {CreateJobRequest} createJobRequest Create a new job
+     * @param {ProcessorApiCreateJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createJob(project: string, createJobRequest: CreateJobRequest, options?: any): AxiosPromise<Job>;
+    createJob(requestParameters: ProcessorApiCreateJobRequest, options?: RawAxiosRequestConfig): AxiosPromise<Job>;
     /**
      * Delete a processor job
      * @summary Delete job
-     * @param {string} job Jobs unique identifier
-     * @param {string} project Projects unique identifier
+     * @param {ProcessorApiDeleteJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteJob(job: string, project: string, options?: any): AxiosPromise<void>;
+    deleteJob(requestParameters: ProcessorApiDeleteJobRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Get a job
      * @summary Get job
-     * @param {string} job Jobs unique identifier
-     * @param {string} project Projects unique identifier
+     * @param {ProcessorApiGetJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getJob(job: string, project: string, options?: any): AxiosPromise<Job>;
+    getJob(requestParameters: ProcessorApiGetJobRequest, options?: RawAxiosRequestConfig): AxiosPromise<Job>;
     /**
      * List your processor jobs
      * @summary List jobs
-     * @param {string} project Projects unique identifier
+     * @param {ProcessorApiListJobsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listJobs(project: string, options?: any): AxiosPromise<ListJobs200Response>;
+    listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListJobs200Response>;
 };
+/**
+ * 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
@@ -382,40 +471,37 @@ export declare class ProcessorApi extends BaseAPI {
     /**
      * Create a new processor job
      * @summary Create job
-     * @param {string} project Projects unique identifier
-     * @param {CreateJobRequest} createJobRequest Create a new job
+     * @param {ProcessorApiCreateJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProcessorApi
      */
-    createJob(project: string, createJobRequest: CreateJobRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Job, any>>;
+    createJob(requestParameters: ProcessorApiCreateJobRequest, 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 {ProcessorApiDeleteJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProcessorApi
      */
-    deleteJob(job: string, project: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    deleteJob(requestParameters: ProcessorApiDeleteJobRequest, 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 {ProcessorApiGetJobRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProcessorApi
      */
-    getJob(job: string, project: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Job, any>>;
+    getJob(requestParameters: ProcessorApiGetJobRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Job, any>>;
     /**
      * List your processor jobs
      * @summary List jobs
-     * @param {string} project Projects unique identifier
+     * @param {ProcessorApiListJobsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProcessorApi
      */
-    listJobs(project: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListJobs200Response, any>>;
+    listJobs(requestParameters: ProcessorApiListJobsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListJobs200Response, any>>;
 }