@teemill/projects 1.52.1 → 1.53.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Projects API
  * Manage PodOS Projects
  *
- * The version of the OpenAPI document: 1.52.1
+ * The version of the OpenAPI document: 1.53.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -108,6 +108,11 @@ export interface CreateTaskRequest {
     'content': string;
     'status': TaskStatus;
 }
+export interface CreateUserGroupRequest {
+    'name': string;
+    'handle': string;
+    'description': string | null;
+}
 export interface ExportTasks202Response {
     /**
      * A message describing the export status
@@ -144,6 +149,9 @@ export interface LegacyProjectLogo {
 export interface ListTasksResponse {
     'tasks': Array<Task>;
 }
+export interface ListUserGroupsResponse {
+    'userGroups'?: Array<UserGroup>;
+}
 export interface NullableIcon {
     'prefix': string;
     'iconName': string;
@@ -421,6 +429,12 @@ export interface UpdateTaskRequest {
      */
     'endDate'?: string | null;
 }
+export interface UpdateUserGroupRequest {
+    'name'?: string;
+    'handle'?: string;
+    'description'?: string | null;
+    'users'?: Array<string> | null;
+}
 export interface UpdateUserRequest {
     'firstName'?: string;
     'lastName'?: string;
@@ -433,6 +447,13 @@ export interface UserClient {
     'createdAt': string;
     'lastAccessed': string;
 }
+export interface UserGroup {
+    'id': string;
+    'name': string;
+    'handle': string;
+    'description': string | null;
+    'users': Array<string> | null;
+}
 export interface UserInvite {
     'inviter': ProjectUser;
     'createdAt': string;
@@ -509,6 +530,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     createTask: (project: string, createTaskRequest?: CreateTaskRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a user group in the project
+     * @summary Create group
+     * @param {string} project Projects unique identifier
+     * @param {CreateUserGroupRequest} [createUserGroupRequest] Create a new user group in the project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUserGroup: (project: string, createUserGroupRequest?: CreateUserGroupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Delete an auth token for the project
      * @summary Delete auth token
@@ -562,6 +592,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteUser: (project: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a user group in the project
+     * @summary Delete group
+     * @param {string} project Projects unique identifier
+     * @param {string} userGroup The user group identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUserGroup: (project: string, userGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Export all the OKRs in the planner
      * @summary Export all OKRs
@@ -683,6 +722,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getUser: (project: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a user group in the project
+     * @summary Get group
+     * @param {string} project Projects unique identifier
+     * @param {string} userGroup The user group identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserGroup: (project: string, userGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get the details of the user\'s invite to the project
      * @summary Get invite
@@ -746,6 +794,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     listTasks: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List the user groups in the project
+     * @summary List groups
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroups: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Reset 2FA for a given user
      * @summary Reset 2FA
@@ -832,6 +888,16 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     updateUser: (project: string, user: string, updateUserRequest: UpdateUserRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a user group in the project
+     * @summary Update group
+     * @param {string} project Projects unique identifier
+     * @param {string} userGroup The user group identifier
+     * @param {UpdateUserGroupRequest} [updateUserGroupRequest] Update a user group in the project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserGroup: (project: string, userGroup: string, updateUserGroupRequest?: UpdateUserGroupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ProjectsApi - functional programming interface
@@ -897,6 +963,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createTask(project: string, createTaskRequest?: CreateTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Task>>;
+    /**
+     * Create a user group in the project
+     * @summary Create group
+     * @param {string} project Projects unique identifier
+     * @param {CreateUserGroupRequest} [createUserGroupRequest] Create a new user group in the project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUserGroup(project: string, createUserGroupRequest?: CreateUserGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserGroup>>;
     /**
      * Delete an auth token for the project
      * @summary Delete auth token
@@ -950,6 +1025,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteUser(project: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Delete a user group in the project
+     * @summary Delete group
+     * @param {string} project Projects unique identifier
+     * @param {string} userGroup The user group identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUserGroup(project: string, userGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Export all the OKRs in the planner
      * @summary Export all OKRs
@@ -1071,6 +1155,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUser(project: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectUser>>;
+    /**
+     * Get a user group in the project
+     * @summary Get group
+     * @param {string} project Projects unique identifier
+     * @param {string} userGroup The user group identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserGroup(project: string, userGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserGroup>>;
     /**
      * Get the details of the user\'s invite to the project
      * @summary Get invite
@@ -1134,6 +1227,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listTasks(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponse>>;
+    /**
+     * List the user groups in the project
+     * @summary List groups
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroups(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUserGroupsResponse>>;
     /**
      * Reset 2FA for a given user
      * @summary Reset 2FA
@@ -1220,6 +1321,16 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateUser(project: string, user: string, updateUserRequest: UpdateUserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectUser>>;
+    /**
+     * Update a user group in the project
+     * @summary Update group
+     * @param {string} project Projects unique identifier
+     * @param {string} userGroup The user group identifier
+     * @param {UpdateUserGroupRequest} [updateUserGroupRequest] Update a user group in the project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserGroup(project: string, userGroup: string, updateUserGroupRequest?: UpdateUserGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserGroup>>;
 };
 /**
  * ProjectsApi - factory interface
@@ -1281,6 +1392,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     createTask(requestParameters: ProjectsApiCreateTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<Task>;
+    /**
+     * Create a user group in the project
+     * @summary Create group
+     * @param {ProjectsApiCreateUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUserGroup(requestParameters: ProjectsApiCreateUserGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserGroup>;
     /**
      * Delete an auth token for the project
      * @summary Delete auth token
@@ -1329,6 +1448,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Delete a user group in the project
+     * @summary Delete group
+     * @param {ProjectsApiDeleteUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUserGroup(requestParameters: ProjectsApiDeleteUserGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Export all the OKRs in the planner
      * @summary Export all OKRs
@@ -1441,6 +1568,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getUser(requestParameters: ProjectsApiGetUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectUser>;
+    /**
+     * Get a user group in the project
+     * @summary Get group
+     * @param {ProjectsApiGetUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserGroup(requestParameters: ProjectsApiGetUserGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserGroup>;
     /**
      * Get the details of the user\'s invite to the project
      * @summary Get invite
@@ -1497,6 +1632,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     listTasks(requestParameters: ProjectsApiListTasksRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTasksResponse>;
+    /**
+     * List the user groups in the project
+     * @summary List groups
+     * @param {ProjectsApiListUserGroupsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroups(requestParameters: ProjectsApiListUserGroupsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListUserGroupsResponse>;
     /**
      * Reset 2FA for a given user
      * @summary Reset 2FA
@@ -1569,6 +1712,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     updateUser(requestParameters: ProjectsApiUpdateUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectUser>;
+    /**
+     * Update a user group in the project
+     * @summary Update group
+     * @param {ProjectsApiUpdateUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserGroup(requestParameters: ProjectsApiUpdateUserGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserGroup>;
 };
 /**
  * Request parameters for archiveTasks operation in ProjectsApi.
@@ -1649,6 +1800,19 @@ export interface ProjectsApiCreateTaskRequest {
      */
     readonly createTaskRequest?: CreateTaskRequest;
 }
+/**
+ * Request parameters for createUserGroup operation in ProjectsApi.
+ */
+export interface ProjectsApiCreateUserGroupRequest {
+    /**
+     * Projects unique identifier
+     */
+    readonly project: string;
+    /**
+     * Create a new user group in the project
+     */
+    readonly createUserGroupRequest?: CreateUserGroupRequest;
+}
 /**
  * Request parameters for deleteAuth operation in ProjectsApi.
  */
@@ -1723,6 +1887,19 @@ export interface ProjectsApiDeleteUserRequest {
      */
     readonly user: string;
 }
+/**
+ * Request parameters for deleteUserGroup operation in ProjectsApi.
+ */
+export interface ProjectsApiDeleteUserGroupRequest {
+    /**
+     * Projects unique identifier
+     */
+    readonly project: string;
+    /**
+     * The user group identifier
+     */
+    readonly userGroup: string;
+}
 /**
  * Request parameters for exportOkrs operation in ProjectsApi.
  */
@@ -1885,6 +2062,19 @@ export interface ProjectsApiGetUserRequest {
      */
     readonly user: string;
 }
+/**
+ * Request parameters for getUserGroup operation in ProjectsApi.
+ */
+export interface ProjectsApiGetUserGroupRequest {
+    /**
+     * Projects unique identifier
+     */
+    readonly project: string;
+    /**
+     * The user group identifier
+     */
+    readonly userGroup: string;
+}
 /**
  * Request parameters for getUserInvite operation in ProjectsApi.
  */
@@ -1976,6 +2166,15 @@ export interface ProjectsApiListTasksRequest {
      */
     readonly project: string;
 }
+/**
+ * Request parameters for listUserGroups operation in ProjectsApi.
+ */
+export interface ProjectsApiListUserGroupsRequest {
+    /**
+     * Projects unique identifier
+     */
+    readonly project: string;
+}
 /**
  * Request parameters for reset2FA operation in ProjectsApi.
  */
@@ -2113,6 +2312,23 @@ export interface ProjectsApiUpdateUserRequest {
      */
     readonly updateUserRequest: UpdateUserRequest;
 }
+/**
+ * Request parameters for updateUserGroup operation in ProjectsApi.
+ */
+export interface ProjectsApiUpdateUserGroupRequest {
+    /**
+     * Projects unique identifier
+     */
+    readonly project: string;
+    /**
+     * The user group identifier
+     */
+    readonly userGroup: string;
+    /**
+     * Update a user group in the project
+     */
+    readonly updateUserGroupRequest?: UpdateUserGroupRequest;
+}
 /**
  * ProjectsApi - object-oriented interface
  */
@@ -2173,6 +2389,14 @@ export declare class ProjectsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     createTask(requestParameters: ProjectsApiCreateTaskRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Task, any, {}>>;
+    /**
+     * Create a user group in the project
+     * @summary Create group
+     * @param {ProjectsApiCreateUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createUserGroup(requestParameters: ProjectsApiCreateUserGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserGroup, any, {}>>;
     /**
      * Delete an auth token for the project
      * @summary Delete auth token
@@ -2221,6 +2445,14 @@ export declare class ProjectsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Delete a user group in the project
+     * @summary Delete group
+     * @param {ProjectsApiDeleteUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUserGroup(requestParameters: ProjectsApiDeleteUserGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Export all the OKRs in the planner
      * @summary Export all OKRs
@@ -2333,6 +2565,14 @@ export declare class ProjectsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getUser(requestParameters: ProjectsApiGetUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectUser, any, {}>>;
+    /**
+     * Get a user group in the project
+     * @summary Get group
+     * @param {ProjectsApiGetUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserGroup(requestParameters: ProjectsApiGetUserGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserGroup, any, {}>>;
     /**
      * Get the details of the user\'s invite to the project
      * @summary Get invite
@@ -2389,6 +2629,14 @@ export declare class ProjectsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     listTasks(requestParameters: ProjectsApiListTasksRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponse, any, {}>>;
+    /**
+     * List the user groups in the project
+     * @summary List groups
+     * @param {ProjectsApiListUserGroupsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUserGroups(requestParameters: ProjectsApiListUserGroupsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUserGroupsResponse, any, {}>>;
     /**
      * Reset 2FA for a given user
      * @summary Reset 2FA
@@ -2461,4 +2709,12 @@ export declare class ProjectsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     updateUser(requestParameters: ProjectsApiUpdateUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectUser, any, {}>>;
+    /**
+     * Update a user group in the project
+     * @summary Update group
+     * @param {ProjectsApiUpdateUserGroupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateUserGroup(requestParameters: ProjectsApiUpdateUserGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserGroup, any, {}>>;
 }