@teemill/projects 1.47.0 → 1.48.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,7 @@
2
2
  * Projects API
3
3
  * Manage PodOS Projects
4
4
  *
5
- * The version of the OpenAPI document: 1.47.0
5
+ * The version of the OpenAPI document: 1.48.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,42 +12,22 @@
12
12
  import type { Configuration } from './configuration';
13
13
  import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
23
  options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
58
38
  description: string;
59
39
  }[];
60
40
  }
61
- /**
62
- *
63
- * @export
64
- */
65
41
  export declare const operationServerMap: ServerMap;
66
42
  export {};
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Projects API
5
5
  * Manage PodOS Projects
6
6
  *
7
- * The version of the OpenAPI document: 1.47.0
7
+ * The version of the OpenAPI document: 1.48.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,21 +13,12 @@
13
13
  */
14
14
  import globalAxios from 'axios';
15
15
  export const BASE_PATH = "https://localhost:8080".replace(/\/+$/, "");
16
- /**
17
- *
18
- * @export
19
- */
20
16
  export const COLLECTION_FORMATS = {
21
17
  csv: ",",
22
18
  ssv: " ",
23
19
  tsv: "\t",
24
20
  pipes: "|",
25
21
  };
26
- /**
27
- *
28
- * @export
29
- * @class BaseAPI
30
- */
31
22
  export class BaseAPI {
32
23
  constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
33
24
  var _a;
@@ -40,12 +31,6 @@ export class BaseAPI {
40
31
  }
41
32
  }
42
33
  ;
43
- /**
44
- *
45
- * @export
46
- * @class RequiredError
47
- * @extends {Error}
48
- */
49
34
  export class RequiredError extends Error {
50
35
  constructor(field, msg) {
51
36
  super(msg);
@@ -53,8 +38,4 @@ export class RequiredError extends Error {
53
38
  this.name = "RequiredError";
54
39
  }
55
40
  }
56
- /**
57
- *
58
- * @export
59
- */
60
41
  export const operationServerMap = {};
@@ -2,7 +2,7 @@
2
2
  * Projects API
3
3
  * Manage PodOS Projects
4
4
  *
5
- * The version of the OpenAPI document: 1.47.0
5
+ * The version of the OpenAPI document: 1.48.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Projects API
5
5
  * Manage PodOS Projects
6
6
  *
7
- * The version of the OpenAPI document: 1.47.0
7
+ * The version of the OpenAPI document: 1.48.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Projects API
3
3
  * Manage PodOS Projects
4
4
  *
5
- * The version of the OpenAPI document: 1.47.0
5
+ * The version of the OpenAPI document: 1.48.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,49 +23,32 @@ export declare class Configuration {
23
23
  /**
24
24
  * parameter for apiKey security
25
25
  * @param name security name
26
- * @memberof Configuration
27
26
  */
28
27
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
28
  /**
30
29
  * parameter for basic security
31
- *
32
- * @type {string}
33
- * @memberof Configuration
34
30
  */
35
31
  username?: string;
36
32
  /**
37
33
  * parameter for basic security
38
- *
39
- * @type {string}
40
- * @memberof Configuration
41
34
  */
42
35
  password?: string;
43
36
  /**
44
37
  * parameter for oauth2 security
45
38
  * @param name security name
46
39
  * @param scopes oauth2 scope
47
- * @memberof Configuration
48
40
  */
49
41
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
42
  /**
51
43
  * override base path
52
- *
53
- * @type {string}
54
- * @memberof Configuration
55
44
  */
56
45
  basePath?: string;
57
46
  /**
58
47
  * override server index
59
- *
60
- * @type {number}
61
- * @memberof Configuration
62
48
  */
63
49
  serverIndex?: number;
64
50
  /**
65
51
  * base options for axios calls
66
- *
67
- * @type {any}
68
- * @memberof Configuration
69
52
  */
70
53
  baseOptions?: any;
71
54
  /**
@@ -4,7 +4,7 @@
4
4
  * Projects API
5
5
  * Manage PodOS Projects
6
6
  *
7
- * The version of the OpenAPI document: 1.47.0
7
+ * The version of the OpenAPI document: 1.48.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Projects API
3
3
  * Manage PodOS Projects
4
4
  *
5
- * The version of the OpenAPI document: 1.47.0
5
+ * The version of the OpenAPI document: 1.48.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Projects API
5
5
  * Manage PodOS Projects
6
6
  *
7
- * The version of the OpenAPI document: 1.47.0
7
+ * The version of the OpenAPI document: 1.48.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Projects API
3
3
  * Manage PodOS Projects
4
4
  *
5
- * The version of the OpenAPI document: 1.47.0
5
+ * The version of the OpenAPI document: 1.48.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Projects API
6
6
  * Manage PodOS Projects
7
7
  *
8
- * The version of the OpenAPI document: 1.47.0
8
+ * The version of the OpenAPI document: 1.48.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,20 @@
1
+ # GetClients200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **clients** | [**Array&lt;UserClient&gt;**](UserClient.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { GetClients200Response } from '@teemill/projects';
14
+
15
+ const instance: GetClients200Response = {
16
+ clients,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # GetLogs200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **logs** | [**Array&lt;UserLog&gt;**](UserLog.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { GetLogs200Response } from '@teemill/projects';
14
+
15
+ const instance: GetLogs200Response = {
16
+ logs,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -15,6 +15,8 @@ Name | Type | Description | Notes
15
15
  **avatar** | [**ProjectUserAvatar**](ProjectUserAvatar.md) | | [default to undefined]
16
16
  **twoFactorAuthentication** | [**TwoFactorAuthentication**](TwoFactorAuthentication.md) | | [default to undefined]
17
17
  **providesSupport** | **boolean** | Whether the user provides support for the project | [optional] [default to undefined]
18
+ **lastAccessed** | **string** | | [optional] [default to undefined]
19
+ **createdAt** | **string** | | [default to undefined]
18
20
 
19
21
  ## Example
20
22
 
@@ -32,6 +34,8 @@ const instance: ProjectUser = {
32
34
  avatar,
33
35
  twoFactorAuthentication,
34
36
  providesSupport,
37
+ lastAccessed,
38
+ createdAt,
35
39
  };
36
40
  ```
37
41
 
@@ -20,15 +20,18 @@ All URIs are relative to *https://localhost:8080*
20
20
  |[**exportOkrs**](#exportokrs) | **GET** /v1/projects/{project}/okrs/export | Export all OKRs|
21
21
  |[**exportTasks**](#exporttasks) | **GET** /v1/projects/{project}/tasks/export | Export all tasks|
22
22
  |[**getAuth**](#getauth) | **GET** /v1/projects/{project}/auth | List auth tokens|
23
+ |[**getClients**](#getclients) | **GET** /v1/projects/{project}/users/{user}/clients | List clients|
23
24
  |[**getIntegration**](#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration|
24
25
  |[**getIntegrations**](#getintegrations) | **GET** /v1/projects/{project}/integrations | List integrations|
25
26
  |[**getInvites**](#getinvites) | **GET** /v1/projects/{project}/invites | List Invites|
27
+ |[**getLogs**](#getlogs) | **GET** /v1/projects/{project}/users/{user}/logs | List logs|
26
28
  |[**getOkrSummary**](#getokrsummary) | **GET** /v1/projects/{project}/okrs/summary | Get OKR summary|
27
29
  |[**getProject**](#getproject) | **GET** /v1/projects/{project} | Get project|
28
30
  |[**getProjects**](#getprojects) | **GET** /v1/projects | List projects|
29
31
  |[**getTask**](#gettask) | **GET** /v1/projects/{project}/tasks/{id} | Get Task|
30
32
  |[**getTemplates**](#gettemplates) | **GET** /v1/projects/templates | List templates|
31
33
  |[**getUser**](#getuser) | **GET** /v1/projects/{project}/users/{user} | Get a user|
34
+ |[**getUserInvite**](#getuserinvite) | **GET** /v1/projects/{project}/users/{user}/invite | Get invite|
32
35
  |[**getUsers**](#getusers) | **GET** /v1/projects/{project}/users | List project users|
33
36
  |[**installIntegration**](#installintegration) | **POST** /v1/projects/{project}/integrations/{integration} | Install integration|
34
37
  |[**installTemplate**](#installtemplate) | **POST** /v1/projects/{project}/templates/{template} | Install integration template|
@@ -958,6 +961,65 @@ const { status, data } = await apiInstance.getAuth(
958
961
 
959
962
  [[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)
960
963
 
964
+ # **getClients**
965
+ > GetClients200Response getClients()
966
+
967
+ List the clients of the project that the user has access to
968
+
969
+ ### Example
970
+
971
+ ```typescript
972
+ import {
973
+ ProjectsApi,
974
+ Configuration
975
+ } from '@teemill/projects';
976
+
977
+ const configuration = new Configuration();
978
+ const apiInstance = new ProjectsApi(configuration);
979
+
980
+ let project: string; //Projects unique identifier (default to undefined)
981
+ let user: string; //the unique id of the user (default to undefined)
982
+
983
+ const { status, data } = await apiInstance.getClients(
984
+ project,
985
+ user
986
+ );
987
+ ```
988
+
989
+ ### Parameters
990
+
991
+ |Name | Type | Description | Notes|
992
+ |------------- | ------------- | ------------- | -------------|
993
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
994
+ | **user** | [**string**] | the unique id of the user | defaults to undefined|
995
+
996
+
997
+ ### Return type
998
+
999
+ **GetClients200Response**
1000
+
1001
+ ### Authorization
1002
+
1003
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1004
+
1005
+ ### HTTP request headers
1006
+
1007
+ - **Content-Type**: Not defined
1008
+ - **Accept**: application/json
1009
+
1010
+
1011
+ ### HTTP response details
1012
+ | Status code | Description | Response headers |
1013
+ |-------------|-------------|------------------|
1014
+ |**200** | Successfully retrieved a list of clients | - |
1015
+ |**400** | Failed validation | - |
1016
+ |**401** | Not authorised to access this resource | - |
1017
+ |**403** | Refuse to authorize | - |
1018
+ |**404** | Resource not found | - |
1019
+ |**500** | Unknown server error | - |
1020
+
1021
+ [[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)
1022
+
961
1023
  # **getIntegration**
962
1024
  > Integration getIntegration()
963
1025
 
@@ -1139,6 +1201,65 @@ const { status, data } = await apiInstance.getInvites(
1139
1201
 
1140
1202
  [[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)
1141
1203
 
1204
+ # **getLogs**
1205
+ > GetLogs200Response getLogs()
1206
+
1207
+ List the logs associated with a user on the project
1208
+
1209
+ ### Example
1210
+
1211
+ ```typescript
1212
+ import {
1213
+ ProjectsApi,
1214
+ Configuration
1215
+ } from '@teemill/projects';
1216
+
1217
+ const configuration = new Configuration();
1218
+ const apiInstance = new ProjectsApi(configuration);
1219
+
1220
+ let project: string; //Projects unique identifier (default to undefined)
1221
+ let user: string; //the unique id of the user (default to undefined)
1222
+
1223
+ const { status, data } = await apiInstance.getLogs(
1224
+ project,
1225
+ user
1226
+ );
1227
+ ```
1228
+
1229
+ ### Parameters
1230
+
1231
+ |Name | Type | Description | Notes|
1232
+ |------------- | ------------- | ------------- | -------------|
1233
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1234
+ | **user** | [**string**] | the unique id of the user | defaults to undefined|
1235
+
1236
+
1237
+ ### Return type
1238
+
1239
+ **GetLogs200Response**
1240
+
1241
+ ### Authorization
1242
+
1243
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1244
+
1245
+ ### HTTP request headers
1246
+
1247
+ - **Content-Type**: Not defined
1248
+ - **Accept**: application/json
1249
+
1250
+
1251
+ ### HTTP response details
1252
+ | Status code | Description | Response headers |
1253
+ |-------------|-------------|------------------|
1254
+ |**200** | Successfully retrieved a list of logs | - |
1255
+ |**400** | Failed validation | - |
1256
+ |**401** | Not authorised to access this resource | - |
1257
+ |**403** | Refuse to authorize | - |
1258
+ |**404** | Resource not found | - |
1259
+ |**500** | Unknown server error | - |
1260
+
1261
+ [[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)
1262
+
1142
1263
  # **getOkrSummary**
1143
1264
  > OkrSummary getOkrSummary()
1144
1265
 
@@ -1477,6 +1598,64 @@ const { status, data } = await apiInstance.getUser(
1477
1598
 
1478
1599
  [[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)
1479
1600
 
1601
+ # **getUserInvite**
1602
+ > UserInvite getUserInvite()
1603
+
1604
+ Get the details of the user\'s invite to the project
1605
+
1606
+ ### Example
1607
+
1608
+ ```typescript
1609
+ import {
1610
+ ProjectsApi,
1611
+ Configuration
1612
+ } from '@teemill/projects';
1613
+
1614
+ const configuration = new Configuration();
1615
+ const apiInstance = new ProjectsApi(configuration);
1616
+
1617
+ let project: string; //Projects unique identifier (default to undefined)
1618
+ let user: string; //the unique id of the user (default to undefined)
1619
+
1620
+ const { status, data } = await apiInstance.getUserInvite(
1621
+ project,
1622
+ user
1623
+ );
1624
+ ```
1625
+
1626
+ ### Parameters
1627
+
1628
+ |Name | Type | Description | Notes|
1629
+ |------------- | ------------- | ------------- | -------------|
1630
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1631
+ | **user** | [**string**] | the unique id of the user | defaults to undefined|
1632
+
1633
+
1634
+ ### Return type
1635
+
1636
+ **UserInvite**
1637
+
1638
+ ### Authorization
1639
+
1640
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1641
+
1642
+ ### HTTP request headers
1643
+
1644
+ - **Content-Type**: Not defined
1645
+ - **Accept**: application/json
1646
+
1647
+
1648
+ ### HTTP response details
1649
+ | Status code | Description | Response headers |
1650
+ |-------------|-------------|------------------|
1651
+ |**200** | Successfully retrieved a user invite | - |
1652
+ |**401** | Not authorised to access this resource | - |
1653
+ |**403** | Refuse to authorize | - |
1654
+ |**404** | Resource not found | - |
1655
+ |**500** | Unknown server error | - |
1656
+
1657
+ [[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)
1658
+
1480
1659
  # **getUsers**
1481
1660
  > ProjectUsers getUsers()
1482
1661
 
@@ -5,7 +5,11 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **providesSupport** | **boolean** | | [default to undefined]
8
+ **firstName** | **string** | | [optional] [default to undefined]
9
+ **lastName** | **string** | | [optional] [default to undefined]
10
+ **username** | **string** | | [optional] [default to undefined]
11
+ **avatar** | **string** | | [optional] [default to undefined]
12
+ **providesSupport** | **boolean** | | [optional] [default to undefined]
9
13
 
10
14
  ## Example
11
15
 
@@ -13,6 +17,10 @@ Name | Type | Description | Notes
13
17
  import { UpdateUserRequest } from '@teemill/projects';
14
18
 
15
19
  const instance: UpdateUserRequest = {
20
+ firstName,
21
+ lastName,
22
+ username,
23
+ avatar,
16
24
  providesSupport,
17
25
  };
18
26
  ```
@@ -0,0 +1,24 @@
1
+ # UserClient
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | | [default to undefined]
9
+ **createdAt** | **string** | | [default to undefined]
10
+ **lastAccessed** | **string** | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { UserClient } from '@teemill/projects';
16
+
17
+ const instance: UserClient = {
18
+ name,
19
+ createdAt,
20
+ lastAccessed,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # UserInvite
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **inviter** | [**ProjectUser**](ProjectUser.md) | | [default to undefined]
9
+ **createdAt** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { UserInvite } from '@teemill/projects';
15
+
16
+ const instance: UserInvite = {
17
+ inviter,
18
+ createdAt,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # UserLog
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **action** | **string** | | [default to undefined]
10
+ **context** | **{ [key: string]: any; }** | | [default to undefined]
11
+ **createdAt** | **string** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { UserLog } from '@teemill/projects';
17
+
18
+ const instance: UserLog = {
19
+ id,
20
+ action,
21
+ context,
22
+ createdAt,
23
+ };
24
+ ```
25
+
26
+ [[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 CHANGED
@@ -4,7 +4,7 @@
4
4
  * Projects API
5
5
  * Manage PodOS Projects
6
6
  *
7
- * The version of the OpenAPI document: 1.47.0
7
+ * The version of the OpenAPI document: 1.48.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/projects",
3
- "version": "1.47.0",
3
+ "version": "1.48.1",
4
4
  "description": "OpenAPI client for @teemill/projects",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {