@teemill/projects 1.52.1 → 1.55.0

package/docs/CreateUserGroupRequest.md

@@ -0,0 +1,24 @@
+# CreateUserGroupRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**handle** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateUserGroupRequest } from '@teemill/projects';
+
+const instance: CreateUserGroupRequest = {
+    name,
+    handle,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ListUserGroupsResponse.md

@@ -0,0 +1,20 @@
+# ListUserGroupsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userGroups** | [**Array<UserGroup>**](UserGroup.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ListUserGroupsResponse } from '@teemill/projects';
+
+const instance: ListUserGroupsResponse = {
+    userGroups,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ProjectsApi.md

@@ -11,12 +11,14 @@ All URIs are relative to *https://localhost:8080*
 |[**createInvite**](#createinvite) | **POST** /v1/projects/{project}/invites | Creates an invite|
 |[**createProject**](#createproject) | **POST** /v1/projects | Create project|
 |[**createTask**](#createtask) | **POST** /v1/projects/{project}/tasks | Create Task|
+|[**createUserGroup**](#createusergroup) | **POST** /v1/projects/{project}/user-groups | Create group|
 |[**deleteAuth**](#deleteauth) | **DELETE** /v1/projects/{project}/auth/{auth} | Delete auth token|
 |[**deleteBookmark**](#deletebookmark) | **DELETE** /v1/projects/{project}/bookmarks/{id} | Delete bookmark|
 |[**deleteInvite**](#deleteinvite) | **DELETE** /v1/projects/{project}/invites/{invite} | Deletes an invite|
 |[**deleteProject**](#deleteproject) | **DELETE** /v1/projects/{project} | Delete project|
 |[**deleteTask**](#deletetask) | **DELETE** /v1/projects/{project}/tasks/{id} | Delete Task|
 |[**deleteUser**](#deleteuser) | **DELETE** /v1/projects/{project}/users/{user} | Delete a user by ID|
+|[**deleteUserGroup**](#deleteusergroup) | **DELETE** /v1/projects/{project}/user-groups/{userGroup} | Delete group|
 |[**exportOkrs**](#exportokrs) | **GET** /v1/projects/{project}/okrs/export | Export all OKRs|
 |[**exportTasks**](#exporttasks) | **GET** /v1/projects/{project}/tasks/export | Export all tasks|
 |[**getAuth**](#getauth) | **GET** /v1/projects/{project}/auth | List auth tokens|
@@ -31,6 +33,7 @@ All URIs are relative to *https://localhost:8080*
 |[**getTask**](#gettask) | **GET** /v1/projects/{project}/tasks/{id} | Get Task|
 |[**getTemplates**](#gettemplates) | **GET** /v1/projects/templates | List templates|
 |[**getUser**](#getuser) | **GET** /v1/projects/{project}/users/{user} | Get a user|
+|[**getUserGroup**](#getusergroup) | **GET** /v1/projects/{project}/user-groups/{userGroup} | Get group|
 |[**getUserInvite**](#getuserinvite) | **GET** /v1/projects/{project}/users/{user}/invite | Get invite|
 |[**getUsers**](#getusers) | **GET** /v1/projects/{project}/users | List project users|
 |[**installIntegration**](#installintegration) | **POST** /v1/projects/{project}/integrations/{integration} | Install integration|
@@ -38,6 +41,7 @@ All URIs are relative to *https://localhost:8080*
 |[**listBookmarks**](#listbookmarks) | **GET** /v1/projects/{project}/bookmarks | List bookmarks|
 |[**listBookmarktabs**](#listbookmarktabs) | **GET** /v1/projects/{project}/bookmarktabs | List bookmark tabs|
 |[**listTasks**](#listtasks) | **GET** /v1/projects/{project}/tasks | List Tasks|
+|[**listUserGroups**](#listusergroups) | **GET** /v1/projects/{project}/user-groups | List groups|
 |[**reset2FA**](#reset2fa) | **POST** /v1/projects/{project}/users/{user}/reset-2fa | Reset 2FA|
 |[**setupIntegration**](#setupintegration) | **POST** /v1/projects/{project}/integrations/{integration}/setup | Setup integration|
 |[**uninstallIntegration**](#uninstallintegration) | **DELETE** /v1/projects/{project}/integrations/{integration} | Uninstall integration|
@@ -47,6 +51,7 @@ All URIs are relative to *https://localhost:8080*
 |[**updateProject**](#updateproject) | **PATCH** /v1/projects/{project} | Update project|
 |[**updateTask**](#updatetask) | **PATCH** /v1/projects/{project}/tasks/{id} | Update Task|
 |[**updateUser**](#updateuser) | **PATCH** /v1/projects/{project}/users/{user} | Update a user|
+|[**updateUserGroup**](#updateusergroup) | **PATCH** /v1/projects/{project}/user-groups/{userGroup} | Update group|
 
 # **archiveTasks**
 > archiveTasks()
@@ -450,6 +455,65 @@ const { status, data } = await apiInstance.createTask(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **createUserGroup**
+> UserGroup createUserGroup()
+
+Create a user group in the project
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration,
+    CreateUserGroupRequest
+} from '@teemill/projects';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let project: string; //Projects unique identifier (default to undefined)
+let createUserGroupRequest: CreateUserGroupRequest; //Create a new user group in the project (optional)
+
+const { status, data } = await apiInstance.createUserGroup(
+    project,
+    createUserGroupRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createUserGroupRequest** | **CreateUserGroupRequest**| Create a new user group in the project | |
+| **project** | [**string**] | Projects unique identifier | defaults to undefined|
+
+
+### Return type
+
+**UserGroup**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successfully retrieved a user group |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **deleteAuth**
 > deleteAuth()
 
@@ -796,6 +860,63 @@ void (empty response body)
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **deleteUserGroup**
+> deleteUserGroup()
+
+Delete a user group in the project
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@teemill/projects';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let project: string; //Projects unique identifier (default to undefined)
+let userGroup: string; //The user group identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteUserGroup(
+    project,
+    userGroup
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Projects unique identifier | defaults to undefined|
+| **userGroup** | [**string**] | The user group identifier | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | User group deleted |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **exportOkrs**
 > File exportOkrs()
 
@@ -1598,6 +1719,64 @@ const { status, data } = await apiInstance.getUser(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getUserGroup**
+> UserGroup getUserGroup()
+
+Get a user group in the project
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@teemill/projects';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let project: string; //Projects unique identifier (default to undefined)
+let userGroup: string; //The user group identifier (default to undefined)
+
+const { status, data } = await apiInstance.getUserGroup(
+    project,
+    userGroup
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Projects unique identifier | defaults to undefined|
+| **userGroup** | [**string**] | The user group identifier | defaults to undefined|
+
+
+### Return type
+
+**UserGroup**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a user group |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getUserInvite**
 > UserInvite getUserInvite()
 
@@ -2002,6 +2181,60 @@ const { status, data } = await apiInstance.listTasks(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **listUserGroups**
+> ListUserGroupsResponse listUserGroups()
+
+List the user groups in the project
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration
+} from '@teemill/projects';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let project: string; //Projects unique identifier (default to undefined)
+
+const { status, data } = await apiInstance.listUserGroups(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Projects unique identifier | defaults to undefined|
+
+
+### Return type
+
+**ListUserGroupsResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a list of user groups |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **reset2FA**
 > reset2FA()
 
@@ -2551,3 +2784,65 @@ const { status, data } = await apiInstance.updateUser(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **updateUserGroup**
+> UserGroup updateUserGroup()
+
+Update a user group in the project
+
+### Example
+
+```typescript
+import {
+    ProjectsApi,
+    Configuration,
+    UpdateUserGroupRequest
+} from '@teemill/projects';
+
+const configuration = new Configuration();
+const apiInstance = new ProjectsApi(configuration);
+
+let project: string; //Projects unique identifier (default to undefined)
+let userGroup: string; //The user group identifier (default to undefined)
+let updateUserGroupRequest: UpdateUserGroupRequest; //Update a user group in the project (optional)
+
+const { status, data } = await apiInstance.updateUserGroup(
+    project,
+    userGroup,
+    updateUserGroupRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateUserGroupRequest** | **UpdateUserGroupRequest**| Update a user group in the project | |
+| **project** | [**string**] | Projects unique identifier | defaults to undefined|
+| **userGroup** | [**string**] | The user group identifier | defaults to undefined|
+
+
+### Return type
+
+**UserGroup**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully retrieved a user group |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/Task.md

@@ -22,6 +22,7 @@ Name | Type | Description | Notes
 **updatedAt** | **string** |  | [default to undefined]
 **displayId** | **number** |  | [default to undefined]
 **relatedTasks** | [**Array<TaskRelatedTasksInner>**](TaskRelatedTasksInner.md) |  | [optional] [default to undefined]
+**ownerPlatform** | **string** | The platform project code of the owner | [default to undefined]
 
 ## Example
 
@@ -46,6 +47,7 @@ const instance: Task = {
     updatedAt,
     displayId,
     relatedTasks,
+    ownerPlatform,
 };
 ```
 

package/docs/UpdateUserGroupRequest.md

@@ -0,0 +1,26 @@
+# UpdateUserGroupRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**handle** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**users** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateUserGroupRequest } from '@teemill/projects';
+
+const instance: UpdateUserGroupRequest = {
+    name,
+    handle,
+    description,
+    users,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UserGroup.md

@@ -0,0 +1,30 @@
+# UserGroup
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**handle** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**users** | **Array<string>** |  | [default to undefined]
+**isSystemAssigned** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UserGroup } from '@teemill/projects';
+
+const instance: UserGroup = {
+    id,
+    name,
+    handle,
+    description,
+    users,
+    isSystemAssigned,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/projects",
-  "version": "1.52.1",
+  "version": "1.55.0",
   "description": "OpenAPI client for @teemill/projects",
   "author": "OpenAPI-Generator Contributors",
   "repository": {