@teemill/projects 1.32.0 → 1.35.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/projects@1.32.0
+## @teemill/projects@1.35.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/projects@1.32.0 --save
+npm install @teemill/projects@1.35.0 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * Projects API
  * Manage PodOS Projects
  *
- * The version of the OpenAPI document: 1.32.0
+ * The version of the OpenAPI document: 1.35.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -118,10 +118,10 @@ export interface Bookmark {
     'color': string | null;
     /**
      * 
-     * @type {Icon}
+     * @type {NullableIcon}
      * @memberof Bookmark
      */
-    'icon': Icon | null;
+    'icon': NullableIcon | null;
 }
 /**
  * @type BookmarkData
@@ -303,6 +303,19 @@ export interface CreateTaskRequest {
 }
 
 
+/**
+ * 
+ * @export
+ * @interface ExportTasks202Response
+ */
+export interface ExportTasks202Response {
+    /**
+     * A message describing the export status
+     * @type {string}
+     * @memberof ExportTasks202Response
+     */
+    'message'?: string;
+}
 /**
  * 
  * @export
@@ -412,10 +425,35 @@ export interface LegacyProjectLogo {
 export interface ListTasksResponse {
     /**
      * 
-     * @type {Array<Task>}
+     * @type {Array<TaskSummary>}
      * @memberof ListTasksResponse
      */
-    'tasks': Array<Task>;
+    'tasks': Array<TaskSummary>;
+}
+/**
+ * 
+ * @export
+ * @interface NullableIcon
+ */
+export interface NullableIcon {
+    /**
+     * 
+     * @type {string}
+     * @memberof NullableIcon
+     */
+    'prefix': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof NullableIcon
+     */
+    'iconName': string;
+    /**
+     * 
+     * @type {Array<any>}
+     * @memberof NullableIcon
+     */
+    'icon': Array<any>;
 }
 /**
  * 
@@ -761,6 +799,12 @@ export interface Task {
      * @memberof Task
      */
     'estimatedHours': number | null;
+    /**
+     * The completion percentage of the task
+     * @type {number}
+     * @memberof Task
+     */
+    'workProgress': number;
     /**
      * The unique id of the user who created the task
      * @type {string}
@@ -792,6 +836,63 @@ export const TaskStatus = {
 export type TaskStatus = typeof TaskStatus[keyof typeof TaskStatus];
 
 
+/**
+ * 
+ * @export
+ * @interface TaskSummary
+ */
+export interface TaskSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof TaskSummary
+     */
+    'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof TaskSummary
+     */
+    'content': string;
+    /**
+     * 
+     * @type {TaskStatus}
+     * @memberof TaskSummary
+     */
+    'status': TaskStatus;
+    /**
+     * The position of the task in its status group
+     * @type {number}
+     * @memberof TaskSummary
+     */
+    'sortOrder': number;
+    /**
+     * The unique id of the user who owns the task
+     * @type {string}
+     * @memberof TaskSummary
+     */
+    'owner': string | null;
+    /**
+     * The estimated hours to complete the task
+     * @type {number}
+     * @memberof TaskSummary
+     */
+    'estimatedHours': number | null;
+    /**
+     * The completion percentage of the task
+     * @type {number}
+     * @memberof TaskSummary
+     */
+    'workProgress': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof TaskSummary
+     */
+    'createdAt': string;
+}
+
+
 /**
  * 
  * @export
@@ -972,6 +1073,12 @@ export interface UpdateTaskRequest {
      * @memberof UpdateTaskRequest
      */
     'estimatedHours'?: number | null;
+    /**
+     * The completion percentage of the task
+     * @type {number}
+     * @memberof UpdateTaskRequest
+     */
+    'workProgress'?: number;
 }
 
 
@@ -1462,6 +1569,47 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Export all the tasks in the workflow
+         * @summary Export all tasks
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportTasks: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('exportTasks', 'project', project)
+            const localVarPath = `/v1/projects/{project}/tasks/export`
+                .replace(`{${"project"}}`, encodeURIComponent(String(project)));
+            // 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};
@@ -1733,6 +1881,51 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get a task in the workflow
+         * @summary Get Task
+         * @param {string} project Projects unique identifier
+         * @param {string} id The unique id of the task
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getTask: async (project: string, id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getTask', 'project', project)
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getTask', 'id', id)
+            const localVarPath = `/v1/projects/{project}/tasks/{id}`
+                .replace(`{${"project"}}`, encodeURIComponent(String(project)))
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // 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};
@@ -2518,6 +2711,19 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['ProjectsApi.deleteUser']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Export all the tasks in the workflow
+         * @summary Export all tasks
+         * @param {string} project Projects unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async exportTasks(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.exportTasks(project, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProjectsApi.exportTasks']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Lists the auth tokens for the project
          * @summary List auth tokens
@@ -2601,6 +2807,20 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['ProjectsApi.getProjects']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get a task in the workflow
+         * @summary Get Task
+         * @param {string} project Projects unique identifier
+         * @param {string} id The unique id of the task
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getTask(project: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Task>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getTask(project, id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProjectsApi.getTask']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * List all templates available
          * @summary List templates
@@ -2907,6 +3127,16 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
         deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
             return localVarFp.deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Export all the tasks in the workflow
+         * @summary Export all tasks
+         * @param {ProjectsApiExportTasksRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportTasks(requestParameters: ProjectsApiExportTasksRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
+            return localVarFp.exportTasks(requestParameters.project, options).then((request) => request(axios, basePath));
+        },
         /**
          * Lists the auth tokens for the project
          * @summary List auth tokens
@@ -2967,6 +3197,16 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
         getProjects(requestParameters: ProjectsApiGetProjectsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<ProjectsResponse> {
             return localVarFp.getProjects(requestParameters.project, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get a task in the workflow
+         * @summary Get Task
+         * @param {ProjectsApiGetTaskRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getTask(requestParameters: ProjectsApiGetTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<Task> {
+            return localVarFp.getTask(requestParameters.project, requestParameters.id, options).then((request) => request(axios, basePath));
+        },
         /**
          * List all templates available
          * @summary List templates
@@ -3310,6 +3550,20 @@ export interface ProjectsApiDeleteUserRequest {
     readonly user: string
 }
 
+/**
+ * Request parameters for exportTasks operation in ProjectsApi.
+ * @export
+ * @interface ProjectsApiExportTasksRequest
+ */
+export interface ProjectsApiExportTasksRequest {
+    /**
+     * Projects unique identifier
+     * @type {string}
+     * @memberof ProjectsApiExportTasks
+     */
+    readonly project: string
+}
+
 /**
  * Request parameters for getAuth operation in ProjectsApi.
  * @export
@@ -3429,6 +3683,27 @@ export interface ProjectsApiGetProjectsRequest {
     readonly project?: string
 }
 
+/**
+ * Request parameters for getTask operation in ProjectsApi.
+ * @export
+ * @interface ProjectsApiGetTaskRequest
+ */
+export interface ProjectsApiGetTaskRequest {
+    /**
+     * Projects unique identifier
+     * @type {string}
+     * @memberof ProjectsApiGetTask
+     */
+    readonly project: string
+
+    /**
+     * The unique id of the task
+     * @type {string}
+     * @memberof ProjectsApiGetTask
+     */
+    readonly id: string
+}
+
 /**
  * Request parameters for getTemplates operation in ProjectsApi.
  * @export
@@ -3869,6 +4144,18 @@ export class ProjectsApi extends BaseAPI {
         return ProjectsApiFp(this.configuration).deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Export all the tasks in the workflow
+     * @summary Export all tasks
+     * @param {ProjectsApiExportTasksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    public exportTasks(requestParameters: ProjectsApiExportTasksRequest, options?: RawAxiosRequestConfig) {
+        return ProjectsApiFp(this.configuration).exportTasks(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Lists the auth tokens for the project
      * @summary List auth tokens
@@ -3941,6 +4228,18 @@ export class ProjectsApi extends BaseAPI {
         return ProjectsApiFp(this.configuration).getProjects(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get a task in the workflow
+     * @summary Get Task
+     * @param {ProjectsApiGetTaskRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    public getTask(requestParameters: ProjectsApiGetTaskRequest, options?: RawAxiosRequestConfig) {
+        return ProjectsApiFp(this.configuration).getTask(requestParameters.project, requestParameters.id, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * List all templates available
      * @summary List templates

package/base.ts

@@ -4,7 +4,7 @@
  * Projects API
  * Manage PodOS Projects
  *
- * The version of the OpenAPI document: 1.32.0
+ * The version of the OpenAPI document: 1.35.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * Projects API
  * Manage PodOS Projects
  *
- * The version of the OpenAPI document: 1.32.0
+ * The version of the OpenAPI document: 1.35.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * Projects API
  * Manage PodOS Projects
  *
- * The version of the OpenAPI document: 1.32.0
+ * The version of the OpenAPI document: 1.35.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -90,11 +90,10 @@ export class Configuration {
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
         this.baseOptions = {
+            ...param.baseOptions,
             headers: {
                 ...param.baseOptions?.headers,
-                'User-Agent': "OpenAPI-Generator/1.32.0/typescript-axios"
             },
-            ...param.baseOptions
         };
         this.formDataCtor = param.formDataCtor;
     }